Skip to main content

getSituationFlags

A Graze API GET request that returns the flags for one or an array of Situations.

See Situation Flags for more information on Moogsoft Enterprise Situation flags.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSituationFlags 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_ids

Array of Numbers

Yes

A list of Situation IDs.

Response

Endpoint getSituationFlags returns the following response:

Successful requests return a JSON object containing the following:

Name

Description

JSON List

List of the states those Situations

Examples

The following examples demonstrate typical use of endpoint getSituationFlags:

Request example

Example cURL request to list an array of all flags associated with Situation 1.

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSituationFlags" --data-urlencode 'sitn_ids=[1,2,3,4]'

Response example

Example response returning the flags associated with Situation 1:

{
    "1": 
    [
        "NOTIFIED",
        "TICKETED"
    ]
}
In this section: