getAlert

A MoogDb v2 method that returns details of an alert.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getAlert takes either the alertID or signaturerequest arguments:

Name

Type

Required

Description

alertId

Number

Yes if no signature provided

Alert ID.

singature

String

Yes if no alertId provided

Alert signature.

Response

Method getAlert returns the following response:

Type

Description

CEvent

A CEvent object containing the alert attributes, such as type and severity.

API update behavior

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.