getSituationDescription
A Graze API GET request that returns the description for a specified Situation.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getSituationDescription takes the following request arguments:
Name | Type | Required | Description |
|---|---|---|---|
| String | Yes | A valid |
| Number | Yes | Situation ID. |
Response
Endpoint getSituationDescription returns the following response:
Successful requests return a JSON object containing the following:
Name | Type | Description |
|---|---|---|
| Number | Situation ID. |
| String | Text in the Situation' description field. |
API behavior in active and historic databases
The behavior of this endpoint depends on whether the relevant Situation is open, closed and still in the active database, or closed and archived to the historic database. This endpoint updates the Situation as follows:
See API Update Behavior for more information on Situation statuses.
Examples
The following examples demonstrate typical use of endpoint getSituationDescription:
Request example
Example cURL request to return the description for Situation ID 231:
curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSituationDescription" --data-urlencode 'sitn_id=231'
Response example
Example response returning the description for Situation ID 231:
{"sitn_id" : "231", "description" : "SyslogLamCookbook source"}