White Papers

OpenManage Essentials-Specific Resource Model
37 REST API Guide–OpenManage Essentials
The enumerated values for the Status field are described in the following table:
Enum
Value
Description
1
Not Acknowledged
2
Acknowledged
For sorting alerts enter attribute names and sort direction separated by commas in corresponding place holders.
Priority of sorting is implicit in ordering of attributes. The enumerated values for the sort direction are described
in the following table:
Enum
Value
Description
0
Ascending - smallest/earliest first (Default)
1
Descending - largest/latest first
Sample URIs for sort are described in the following table:
URI
Result
<BASE_URI>/Alerts/$sort(colu
mn=Id,Status;direction=0,1)
Alerts sorted by Id (Ascending) and then by Status(Descending)
<BASE_URI>/Alerts/$top=5&$
sort(column=Id,Status;directio
n=0,1)
First 5 alerts from the list of alerts sorted by Id (Ascending) and then by
Status(Descending)
<BASE_URI>/Alerts/$skip=10
&$top=5&$sort(column=Id,Sta
tus;direction=0,1)
5 alerts skipping first 10 from the list of alerts sorted by Id (Ascending)
and then by Status(Descending)
<BASE_URI>/Alerts/$sort(colu
mn=Id,Status;direction=0,1)?S
everity=8
All warning alerts sorted by Id (Ascending) and then by
Status(Descending)
2.8.1 Delete Alerts
<BASE_URI>/Alerts/{id}{|{id}}
Operation: DELETE
To delete an alert use the standard HTTP DELETE operation.
2.8.2 Acknowledge Alerts
<BASE_URI>/Alerts/{id}{|{id}}
Operation: PUT
To acknowledge an alert or clear the acknowledgement use the standard HTTP PUT operation. For the content
of the URL PUT request use plain text (text/plain) and send ‘status=clear’ or ‘status=acknowledge’ to update
the status. Requesting an acknowledgement or clearing an acknowledgement can be requested regardless of
the current status. The requested status will become the current status. Any other operations will be considered
an error.
The requested action can be applied to a list of alerts by adding additional alert ids separated by a pipe (|).