Manualshelf

API Guide

ManualsBrandsDell ManualsActive System ManagerEMC OpenManage Enterprise
31323334353637383940
Table Of Contents
Security considerations
For performing update and delete operations, you must be authorized to perform the operations on the resource. If you do not
have the required permission, an Unauthorized error is returned.
Performance considerations
The expected time taken to run individual APIs for retrieving data from a database is a few seconds.
When data is retrieved from multiple servers by enumeration for generating reports, it may take ample time to run multiple
iterations with multiple queries per server. The time taken and the utilization of resources is more and may impact the
performance of the OpenManage Enterprise appliance. For generating reports, it is recommended to use integrated or custom
reports for retrieving information from a large number of servers that are required on a regular basis.
Data filtering
The console software provides filtering options on certain URIs that return a collection of entities. Using this feature, the clients
can extract a selected set of records using comparison operators on attributes of the model entity behind the collection. The
relevant URI sections contain the information about the attributes and the operators that support filtering.
<Collection API>?$filter=<attribute> <operator> <value>&<attribute> <operator> <value>
Examples:
Filter devices by
system ID
/api/DeviceService/Devices?$filter=SystemId eq 123
Filter devices by
model
/api/DeviceService/Devices?$filter=Model eq 'PowerEdge MX740c'
Filter devices by
device type
/api/DeviceService/Devices?$filter=Type eq 3000 or Type eq 5000
NOTE: For enumeration of Type, see /api/DeviceService/DeviceType.
For more information about $filter, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org.
Data sorting
The console software provides sorting options on certain URIs that return a collection of entities. The sorting options enable the
clients to get sorted results using the Sort operators on certain attributes of the model entity behind the collection. The relevant
URI section contain information about the attributes that support sorting.
<Collection API>?$orderby=<attribute> <asc/desc>
Examples: Get devices sorted in ascending order by Status
/api/DeviceService/Devices?$orderby=Status asc
NOTE: For enumeration of Status, see /api/DeviceService/DeviceStatuses.
NOTE: For more information about $orderby, see OData Version 4.0 Part 1: Protocol at docs.oasis-open.org.
Key integration concepts 33