event.acknowledge

Description

object event.acknowledge(object/array **parameters**)

This method allows to update events. Following update actions can be performed:

  • Close event. If event is already resolved, this action will be skipped.

  • Acknowledge event. If event is already acknowledged, this action will be skipped.

  • Add message.

  • Change event severity. If event already has same severity, this action will be skipped.

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.

Parameters

(object/array) Parameters containing the IDs of the events and update operations that should be performed.

ParameterTypeDescription
eventids
(required)		string/objectIDs of the events to acknowledge.
action
(required)		integerEvent 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;
16 - unacknowledge event.
messagestringText of the message.
Required, if action contains ‘add message’ flag.
severityintegerNew 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.

Return values

(object) Returns an object containing the IDs of the updated events under the eventids property.

Examples

Acknowledging an event

Acknowledge a single event and leave a message.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "event.acknowledge",
  4.     "params": {
  5.         "eventids": "20427",
  6.         "action": 6,
  7.         "message": "Problem resolved."
  8.     },
  9.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10.     "id": 1
  11. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "eventids": [
  5.             "20427"
  6.         ]
  7.     },
  8.     "id": 1
  9. }

Changing event’s severity

Change severity for multiple events and leave a message.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "event.acknowledge",
  4.     "params": {
  5.         "eventids": ["20427", "20428"],
  6.         "action": 12,
  7.         "message": "Maintenance required to fix it.",
  8.         "severity": 4
  9.     },
  10.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  11.     "id": 1
  12. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "eventids": [
  5.             "20427",
  6.             "20428"
  7.         ]
  8.     },
  9.     "id": 1
  10. }

Source

CEvent::acknowledge() in ui/include/classes/api/services/CEvent.php.