Moogsoft Docs

getSituationServices

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

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSituationServices takes the following request arguments:

Name

Type

Required

Description

situationId

Number

Yes

Situation ID.

Response

Method getSituationServices returns the following response:

Type

Description

Native Object

A JSON array containing the service names, and the Situation's primary service, 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 getSituationServices:

Response example

Example response returning the services and the primary service for a Situation:

{ 
    "services": [
        "Service1",
        "Service2"
    ],
    "primary": "Service1"
}