Moogsoft Docs

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.

API behavior in active and historic databases

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

See API Update Behavior for more information on Situation statuses.

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