object event.acknowledge(object/array parameters)
This method allows to update events. Following update actions can be performed:
Only trigger events can be updated.
Only problem events can be updated.
Read/Write rights for trigger are required to close the event or to change event's severity.
To close an event, manual close should be allowed in the trigger.
(object/array)
Parameters containing the IDs of the events and update operations that should be performed.
Parameter | Type | Description |
---|---|---|
eventids (required) |
string/object | IDs of the events to acknowledge. |
action (required) |
integer | Event update action(s). This is bitmask field, any combination of values is acceptable. Possible values: 1 - close problem; 2 - acknowledge event; 4 - add message; 8 - change severity. |
message | string | Text of the message. Required, if action contains 'add message' flag. |
severity | integer | New severity for events. Required, if action contains 'change severity' flag. Possible values: 0 - not classified; 1 - information; 2 - warning; 3 - average; 4 - high; 5 - disaster. |
(object)
Returns an object containing the IDs of the updated events under the eventids
property.
Acknowledge a single event and leave a message.
Request:
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": "20427",
"action": 6,
"message": "Problem resolved."
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
Change severity for multiple events and leave a message..
Request:
{
"jsonrpc": "2.0",
"method": "event.acknowledge",
"params": {
"eventids": ["20427", "20428"],
"action": 12,
"message": "Maintenance required to fix it.",
"severity": 4
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}
Response:
CEvent::acknowledge() in frontends/php/include/classes/api/services/CEvent.php.