Moogsoft Docs

getAlertCustomInfo

A MoogDb v2 method that returns custom information for an alert.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getAlertCustomInfo takes the following request arguments:

Name

Type

Required

Description

alertId

Number

Yes

ID of the alert you want to return custom info data for.

key

String

No

Specify the key if you are interested in a specific value. Otherwise the method returns all custom info.

Response

Method getAlertCustomInfo returns the following response:

Type

Description

Number, List, String, or Object

A map of name-value pairs containing the custom info for the specified alert.

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.