Moogsoft Docs

getSituationProcesses

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

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getSituationProcesses 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 you want to return the process names for.

Response

Endpoint getSituationProcesses returns the following response:

Successful requests return a JSON object containing the following:

Name

Type

Description

processes

List

A list of all the Situation's process names.

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

Request example

Example cURL request to return all the process names for Situation 473:

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

Response example

Example response returning a list of all the Situation's process names:

{
    "processes":[
        "Knowledge Management",
        "Online Transaction Processing",
        "Web Content Management",
        "40GbE",
        "8-bit Unicode Transcoding Platform"
    ]
}