API Guide
Chapter 1: About this document....................................................................................................... 6
Chapter 2: Overview....................................................................................................................... 7
Introduction to Power Manager...........................................................................................................................................7
RESTful application programming interface.......................................................................................................................7
OData...................................................................................................................................................................................... 7
JSON data.............................................................................................................................................................................. 7
HTTPS communication......................................................................................................................................................... 8
Chapter 3: Key integration concepts.................................................................................................9
Base URI................................................................................................................................................................................. 9
OEM scheme....................................................................................................................................................................9
Security................................................................................................................................................................................. 10
Authentication...................................................................................................................................................................... 10
Authorization.........................................................................................................................................................................10
Resource addressing............................................................................................................................................................ 11
Resource operations............................................................................................................................................................ 12
Security considerations....................................................................................................................................................... 12
Data filtering..........................................................................................................................................................................12
Data sorting...........................................................................................................................................................................13
Data pagination.....................................................................................................................................................................13
Request headers...................................................................................................................................................................13
Response codes................................................................................................................................................................... 14
Response headers................................................................................................................................................................ 14
Chapter 4: Settings....................................................................................................................... 16
/api/PowerService/Settings..............................................................................................................................................16
GET method for Power Service Settings....................................................................................................................16
/api/PowerService/Actions/PowerService.UpdateSettings.........................................................................................17
POST method for Power Service Settings................................................................................................................. 17
Chapter 5: Monitored Devices........................................................................................................ 21
/api/PowerService/Actions/PowerService.AddDevices............................................................................................... 21
POST method to add Devices...................................................................................................................................... 21
/api/PowerService/Actions/PowerService.RemoveDevices........................................................................................21
POST method to remove Monitored Devices........................................................................................................... 22
/api/PowerService/MonitoredDevices............................................................................................................................22
GET method for Monitored Devices........................................................................................................................... 22
Chapter 6: Monitored Groups.........................................................................................................26
/api/PowerService/Actions/PowerService.AddGroups............................................................................................... 26
POST method to add Groups...................................................................................................................................... 26
/api/PowerService/Actions/PowerService.RemoveGroups........................................................................................26
POST method to remove Monitored Groups.............................................................................................................27
Contents
Contents 3