Moogsoft Docs

removeSituationPrimaryTeam

A Graze API POST request that removes the primary team from a Situation. The team remains assigned to the Situation.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint removeSituationPrimaryTeam takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

sitn_id

Number

Yes

ID of the Situation that you want to remove the primary team from.

Response

Endpoint removeSituationPrimaryTeam returns the following response:

Successful requests return a JSON object containing the following:

Name

Type

Description

sitn_id

Number

ID of the Situation that the primary team has been removed from.

API update behavior

The behavior of this endpoint depends on whether the relevant Situation is open, closed and still in the active database, or closed and archived to the historic database. This endpoint updates the Situation as follows:

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of endpoint removeSituationPrimaryTeam:

Request example

Example cURL request to remove the primary team from Situation 1906:

curl -G -u graze:graze -k "https://localhost/graze/v1/removeSituationPrimaryTeam" --data-urlencode 'sitn_id=1906'
Response example

Example response returning the Situation ID that the primary team has been removed from:

{
    "sitn_id": 1906
}