API Guide
Table Of Contents
- OpenManage Enterprise Power Manager RESTful API Guide version 1.1
- About this document
- Overview
- Key integration concepts
- Settings
- Monitored Devices
- Monitored Groups
- Power Policy
- api/PowerService/PowerBounds
- /api/PowerService/Policies
- /api/PowerService/Policies(
) - /api/PowerService/Policies(
)/PolicyDetails - /api/PowerService/MonitoredDevices(
)/Policies - /api/PowerService/MonitoredGroups(
)/Policies - /api/PowerService/Actions/PowerService.CreatePolicy
- /api/PowerService/Actions/PowerService. EditPolicy
- /api/PowerService/Actions/PowerService.EnablePolicies
- /api/PowerService/Actions/PowerService.DisablePolicies
- /api/PowerService/Actions/PowerService.DeletePolicies
- Emergency Power Reduction
- Report Service
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 using
equal operator
/api/DeviceService/Devices?$filter=Model eq 'PowerEdge MX740c'
Filter devices
by model using
contains operator
/api/PowerService/MonitoredDevices?$filter=contains(Model,'PowerEdge')
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.
Adding
combinations of
filters
/api/PowerService/MonitoredDevices?$filter=contains(Model,'PowerEdge') and
Type eq 2000
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.
Data pagination
The console software provides pagination options on certain URIs that return a collection of entities. The pagination options
enable the clients to get paginated results. If a URI supports pagination, the relevant URI sections indicate it.
<Collection API>?$top=<required number of records>&$skip=<number of records to skip>
Examples:
Get 5
th
to 8
th
devices from the
Device collection
/api/DeviceService/Devices?$skip=4&$top=4
Key integration concepts 13