Skip to main content

setResolvingThreadEntry

A Graze API POST request that sets or clears a thread entry in a Situation as a resolving step. Threads are comments or 'story activity' on Situations.

This endpoint returns a Boolean indicating whether the thread entry was successfully set or cleared as a resolving step.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint setResolvingThreadEntry takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

entry_id

Number

Yes

ID of the thread entry.

resolving_step

Boolean

Yes

Whether you are setting or clearing the thread entry as a resolving step.

Response

Endpoint setResolvingThreadEntry returns the following response:

Successful requests return a JSON object containing the following:

Type

Description

Boolean

Whether or not the thread entry was successfully set or cleared as a resolving step.

API update behavior

The behavior of this endpoint depends on whether the relevant alert or Situation is open, closed and still in the active database, or closed and archived to the historic database. This endpoint updates the alert or Situation as follows:

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint setResolvingThreadEntry:

Request example

Example cURL request to set thread entry 28 as a resolving step:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/setResolvingThreadEntry" -H "Content-Type: application/json; charset=UTF-8" -d '{"entry_id" : 28, "resolving_step" : true}'

Response example

Example response returning that the thread entry was successfully set as a resolving step:

true
In this section: