getSituationProcesses

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

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. 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	ID of the Situation you want to return the process names for.

Response

Endpoint getSituationProcesses returns the following response:

Type	Description
HTTP Code	HTTP status or error code indicating request success or failure. See HTTP status code definitions for more information.

Successful requests return a JSON object containing the following:

Name	Type	Description
`processes`	Array	A list of all the Situation's process names.

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"
    ]
}