White Papers
9 REST API Guide OpenManage Essentials | Revision A02
1.7 Security considerations
The OpenManage Essentials REST PUT and DELETE operations requires the user IDs used to run these
commands have write access to the base directory where the OpenManage Essentials REST services are
installed. If the write permission on this directory is not enabled for the user IDs used to access the DELETE
and PUT operations, an error is returned indicated that the access is .
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
The devices with a health status identified by 16 (Critical) are returned. The number of devices returned could
be less than the maximum of 100 that was requested.