addSigCorrelationInfo

A MoogDb v2 method that adds correlation information (external service name and external entity ID) to a Situation.

This is the recommended method for adding correlation information to a Situation, the addCorrelationInfo method has been retained for backwards compatibility.

Back to MoogDb V2 API Method Reference.

Request arguments

Method addSigCorrelationInfo takes the following request arguments:

Name	Type	Required	Description
`situationId`	Number	Yes	Situation ID.
`service`	String		Name of the external service, such as `ServiceNow`.
`externalId`	String		Identifier that the entity has in the external service, which corresponds to the Situation.

Response

Method addSigCorrelationInfo returns the following response:

Type	Description
Boolean	Indicates whether or not the operation was successful: `true` = success, `false` = fail.

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:

Alert/Situation Status	API Updates or Retrieves Alert/Situation
Open alert/Situation	Yes
Closed alert/Situation in active database	Yes
Closed alert/Situation in historic database	No

See API Update Behavior for more information on Situation statuses.

Examples

The following examples demonstrate typical use of method addSigCorrelationInfo:

Response example

In this section: