updateSituation

A MoogDb v2 method that takes a Situation object and uses it to update the database and the Message Bus.

Back to MoogDb V2 API Method Reference.

Request arguments

Method updateSituation takes the following request arguments:

Name

Type

Required

Description

situationObject

CEvent

Yes

Object containing the Situation details.

Response

Method updateSituation 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 updateSituation:

Response example