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 |
|---|---|---|---|
| Number | Yes | Situation ID. |
| Object | Yes | A map of name value pairs containing the new custom information. |
| Boolean | No |
Response
Method setSigCustomInfo returns the following response:
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.
Examples
The following examples demonstrate typical use of method setSigCustomInfo:
Request examples
Example request to add the incident number to the custom info field custom_info.inc. merge is set to true so this new data is merged with the existing data.
moogdb.setSigCustomInfo(situationId, {"inc": incidentNumber} , true);Example request to set ticketing.status.deep.key.name.fred.barney in the custom info in Situation ID 234 to "failed". This example shows how you can set a deeply nested key without having to build the whole object.
moogdb.setSigCustomInfo(234,"ticketing.status.deep.key.name.fred.barney","failed");