moveSituationToCategory
A MoogDb v2 method that moves a Situation into a new category. A category represents a type of Situation, indicating how it was created or its state. See Create Shared Alert and Situation Filters for more information.
Back to MoogDb V2 API Method Reference.
Request arguments
Method moveSituationToCategory takes the following request arguments:
Name | Type | Required | Description |
|---|---|---|---|
| Number | Yes | Situation ID. |
| String | Yes | Name of the new category you want to assign the Situation to. |
Response
Method moveSituationToCategory 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 moveSituationToCategory:
Request example
Example request to move Situation ID 123 to the category "Detected":
var result=moogdb.moveSituationToCategory(123, "Detected");