Skip to main content

assignAndAcknowledgeSituation

A Graze API POST request that assigns and acknowledges the moderator to the Situation for a specified situation ID and user ID.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint assignAndAcknowledgeSituation 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_id

Number

Yes

Situation ID.

user_id

Number

Yes

ID of the user to be assigned as the owner of the Situation.

username

String

No

Username of the user to be assigned to the Situation.

Response

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

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint assignAndAcknowledgeSituation:

Request example

Example cURL request to set user ID 7 as the moderator on Situation ID 975 and acknowledge this:

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

Response example

In this section: