API Guide

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