getSituationsWithFlag

A Graze API GET request that returns all the Situations which have the specified flag.

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

Request arguments

Endpoint getSituationsWithFlag 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.
`flag`	String	Yes	Name of the flag to search for.
`start`	Number	No	Starting point of the result set to return. Default is 0.
`limit`	Number	No	Maximum number of results to return. Default is 1000.

Endpoint getSituationsWithFlag returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return a JSON object containing the following:

Type	Description
JSON Array	An array of the Situation IDs that have the specified flag associated with them.

The following examples demonstrate typical use of endpoint getSituationsWithFlag:

Example cURL request to retrieve all Situations that have the specified flag associated with them.

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSituationsWithFlag" --data-urlencode 'flag=NOTIFIED'

Example response returning an array of all of the Situations that have the specified flag associated with them:

[ 1, 2, 5 ]

In this section: