Moogsoft Docs

getSituationAlertIds

A MoogDb v2 method that returns the total number of alerts, and a list of their alert IDs, for a Situation. This can be either all alerts or just those alerts unique to the Situation.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSituationAlertIds takes the following request arguments:

Name

Type

Required

Description

situationId

Number

Yes

Situation ID.

uniqueOnly

Boolean

No

Response

Method getSituationAlertIds returns the following response:

Type

Description

Native Object

A JSON object containing the total number of alerts and the alert IDs for the specified Situation.

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

Response example

Example response returning the total number of alerts and the alert IDs for the specified Situation:

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