Moogsoft Docs

getSituationServices

A Graze API GET request that returns a list of external service names for a specified Situation.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSituationServices 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

Situation ID.

Response

Endpoint getSituationServices returns the following response:

Successful requests return a JSON object containing the following:

Name

Type

Description

services

Array

A list of the Situation's services.

API behavior in active and historic databases

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 getSituationServices:

Request example

Example cURL request to return the services for Situation ID 345:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSituationServices" --data-urlencode 'sitn_id=345'

Response example

Example response returning the services for the specified Situation:

{
   "services":[
       "Cloud Management Platform",
       "Geographic Information Systems",
       "Knowledge Management",
       "Online Transaction Processing",
       "Storage Subsystem",
       "Web Content Management",
       "0-bit Emulation","40GbE",
       "8-bit Unicode Transcoding Platform"
   ]
}