Skip to main content

getSituationProcesses

A MoogDb v2 method that returns a list of process names for a Situation, and the primary process name, if defined.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSituationProcesses takes the following request arguments:

Name

Type

Required

Description

situationId

Number

Yes

Situation ID.

Response

Method getSituationProcesses returns the following response:

Type

Description

Native Object

A JSON array containing the process names, and the Situation's primary process, if defined.

Examples

The following examples demonstrate typical use of method getSituationProcesses:

Response example

Example response returning the processes and the primary process for a Situation:

{ 
    "processes": ["Process1", "Process2"],
    "primary": "Process2"
}