Moogsoft Docs

getActiveSituationIds

A MoogDb v2 method that returns the total number of active Situations, and a list of their Situation IDs. Active Situations are those that are not Closed, Resolved or Dormant.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getActiveSituationIds takes no request arguments.

Response

Method getActiveSituationIds returns the following response:

Type

Description

Native Object

A JSON object containing the total number of Situations returned and the Situation IDs.

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

Response example

Example response returning ten active Situations:

{
     "total_situations":10,
     "sitn_ids":[4, 5, 6, 12, 14, 15, 16, 17, 18, 19]
}