Skip to main content

removeAlertFromSituation

A Graze API POST request that removes a specified alert from a specified Situation.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint removeAlertFromSituation 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.

alert_id

Number

Yes

ID of the alert you want to remove from the Situation.

sitn_id

Number

Yes

Situation ID.

Response

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

This endpoint does not remove the alert from the Situation if the alert has been archived to the historic database even if the Situation is still in the active database.

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint removeAlertFromSituation:

Request example

Example cURL request to remove alert 16 from Situation 7:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/removeAlertFromSituation" -H "Content-Type: application/json; charset=UTF-8" -d '{"alert_id" : 16, "sitn_id" : 7 }'

Response example

In this section: