Moogsoft Docs

getSigCustomInfo

A MoogDb v2 method that returns all custom info related to a Situation.

Back to MoogDb V2 API Method Reference.

Request arguments

Method getSigCustomInfo takes the following request arguments:

Name

Type

Required

Description

sigId

Number

Yes

Situation ID.

key

String

Node path for specific value to return.

Response

Method getSigCustomInfo returns the following response:

Type

Description

Number, Object, Array or String

Response depends on the key but can be a number, object, array or string containing a list of maps of custom info.

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.