setSituationProcesses
A MoogDb v2 method that applies a list of processes to a Situation. Any other processes already associated with the Situation are removed.
Back to MoogDb V2 API Method Reference.
Request arguments
Method setSituationProcesses takes the following request arguments:
Name | Type | Required | Description |
|---|---|---|---|
| Number | Yes | Situation ID. |
| JSON Array | Yes | A Javascript array of process names as text strings. If any processes supplied do not exist in the database, the request creates them and assigns them to the Situation. |
Response
Method setSituationProcesses 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 setSituationProcesses: