Skip to main content

addSituationCustomInfo

A Graze API POST request that adds and merges custom information for a specified Situation.

Back to Graze API EndPoint Reference.

Request arguments

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

custom_info

JSON Object

Yes

A JSON object containing the custom information.

Response

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

Request example

Example cURL request to add custom info to "field1", "field2", "field3", and "field4" in Situation ID 5:

curl -X POST -u graze:graze -k -v "https://localhost/graze/v1/addSituationCustomInfo" -H "Content-Type: application/json; charset=UTF-8" -d '{"sitn_id" : 5, "custom_info" : { "field1" : "value1" , "field2" : "value2" , "field3" : ["item1","item2","item3"] , "field4" : {"field4-1" : "value4-1","field4-2" : "value4-2"} }}'

Response example

In this section: