Skip to main content

createThread

A Graze API POST request that creates a new thread for a specified Situation. Threads are comments or 'story activity' on Situations.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint createThread 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.

sitn_id

Number

Yes

ID of the Situation you want to create a new thread for.

thread_name

String

Yes

Name of the new thread.

Response

Endpoint createThread returns the following response:

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 createThread:

Request example

Example cURL request to create a new thread "Thread 0958" on Situation ID 176:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/createThread" -H "Content-Type: application/json; charset=UTF-8" -d '{"sitn_id" : 176, "thread_name" : "Thread 0958"}

Response example