White Papers

10 REST API Guide  OpenManage Essentials | Revision A02
Is user local
administrator?
Role
HTTP Method
GET
POST
PUT
DELETE
Yes
OmeAdministrators
Yes
Yes
Yes
Yes
OmePowerUsers
Yes
Yes
Yes
Yes
OmeUsers
Yes
No
No
No
No
OmeAdministrators
Yes
Yes
No
No
OmePowerUsers
Yes
Yes
No
No
OmeUsers
Yes
No*
No
No
*For Site Administrators not having local administrator privilege, the POST method is
permitted if the specified operation is allowed by using the GUI.
1.8 Data filtering and sorting
Data filtering can be accomplished by associating queries with the GET request. In the simplest form, it is a set
of parameter name/value pairs that are appended to the request. The following is an example of data filtering:
<BASE_URI>/Alerts?Severity=16&Status=2
(To get the list of critical acknowledged alerts 16: Critical Severity, 2: Status Acknowledged)
Data sorting can be achieved by providing column names and corresponding directions in sort clause. Sort
priority is implicit in the ordering of the column names. The following is an example of data sorting:
<BASE_URI>/Alerts/$sort(column=Id,Status;direction=0,1)
(To get list of alerts sorted in ascending by Id and then in descending by Status)
1.9 Data pagination
Data pagination can be accomplished by providing additional information in the GET request corresponding to
a chunk of data. The response returns information on the total number of entries that could be used to reset
any page numbering if the data has changed since the last call.
<BASE_URI>/Alerts/$top=250
This query will return the first chunk of data corresponding to the top 250 records.
<BASE_URI>/Alerts/$skip=250&$top=250
This query will skip the first 250 records and return effectively the next 250 records.
Note: The pagination keywords ($top and $skip) are case-sensitive.
Data pagination may be combined with data filtering. However, the data pagination key-value pairs must appear
first. For example, if you want to retrieve the top 100 devices with critical status, use the following command:
<BASE_URI>/Devices/$top=100?GlobalStatus=16