Skip to main content

setSituationDescription

A Graze API POST request that sets the description for a specified Situation.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint setSituationDescription 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

Situation ID.

description

String

Yes

Description for the Situation ID.

Response

Endpoint setSituationDescription 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 setSituationDescription:

Request example

Example cURL request to set the description for Situation ID 6 as "This is my description 12345":

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/setSituationDescription" -H "Content-Type: application/json; charset=UTF-8" -d '{"sitn_id" : 6, "description" : "This is my description 12345"}'

Response example

In this section: