Moogsoft Docs

setSigCustomInfo

A MoogDb v2 method that updates the custom information for a Situation.

The Situation ID and new custom information are both contained in the situationInfo CEvent. The new custom information is contained in the customInfoMap object.

Back to MoogDb V2 API Method Reference.

Request arguments

Method setSigCustomInfo takes the following request arguments:

Name

Type

Required

Description

situationId

Number

Yes

Situation ID.

customInfoMap

Object

Yes

A map of name value pairs containing the new custom information.

merge

Boolean

No

Response

Method setSigCustomInfo returns the following response:

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

Response example