getActiveSituationIds
A Graze API GET request that returns the total number of active Situations, and a list of their Situation IDs. Active Situations are those that are not Closed, Resolved or Dormant.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getActiveSituationIds takes the following request argument:
Endpoint getActiveSituationIds takes no other arguments because this endpoint returns data on all active Situations.
Response
Endpoint getActiveSituationIds returns the following response:
Successful requests return a JSON object containing the following:
Name | Type | Description |
|---|---|---|
| Number | Total number of active Situations. |
| Array | A list of active Situation IDs. |
Examples
The following examples demonstrate typical use of endpoint getActiveSituationIds:
Request example
Example cURL request to return all active Situations in Moogsoft Onprem:
curl -G -u graze:graze -k -v "https://localhost/graze/v1/getActiveSituationIds"
Response example
Example response returning the IDs of ten Situations:
{
"total_situations": 10,
"sitn_ids": [4, 5, 6, 12, 14, 15, 16, 17, 18, 19]
}