Skip to main content

DELETE /events/acknowledgeAlerts

Use this method to remove the acknowledgement for one or more active alerts.

Note
This API requires Lenovo XClarity Administrator v3.0.0 or later.

Authentication​

Authentication with username and password is required.

Request URL​

DELETE https://{management_server_IP}/events/acknowledgeAlerts

Query parameters​

None

Request body​

ParameterRequired / OptionalTypeDescription
componentID StringID of the component that raised the alert
date StringTime and date that the event was raised on source device. This is the time and date from the managed device and might be different from timestamp when the alert was processed by the Lenovo XClarity Administrator.

This timestamp is specified using ISO-8601 format (for example, 2019-05-02T19:28:14.000Z). For information about ISO-8601 format, see the W3C Date and Time Formats webpage.

eventID StringEvent ID of the event that is associated with the alert
sourceID StringID of the parent of the component that raised the alert

If there is no parent, this is the same as the component ID.

The following example remove the acknowledgement for an active alert.
{
   "componentID": "3015DE7E2B6011E881940A94EF5F5B65",
   "date": "2019-07-08T16:19:10Z",
   "eventID": "FQXHMDM0163J",
   "sourceID": "3015DE7E2B6011E881940A94EF5F5B65"
}
The following example remove the acknowledgement for two active alerts.
[{
   "componentID": "3015DE7E2B6011E881940A94EF5F5B65",
   "date": "2020-06-16T16:10:26.000Z",
   "eventID": "0X806F030C2001FFFF",
   "sourceID": "3015DE7E2B6011E881940A94EF5F5B65"
},
{
   "componentID":"3015DE7E2B6011E881940A94EF5A832",
   "date" : "2020-06-16T16:10:26.000Z",
   "eventID":"0X806F030C2001FFFF",
   "sourceID":"3015DE7E2B6011E881940A94EF5A832"
}]

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
206Partial ContentThe part, but not all, of the request completed successfully.

A descriptive message is returned in the response body indicating how many acknowledgements were deleted, how many did not exist, how many were invalid, and how many failed to be deleted.

400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
409ConflictThere is a conflict with the current state of the resource. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

None