API Guide

Chapter 1: About this document................................................................................................... 17
Chapter 2: Overview.................................................................................................................... 19
RESTful application programming interface................................................................................................................19
OData.................................................................................................................................................................................... 19
JSON data........................................................................................................................................................................... 19
HTTPS communication..................................................................................................................................................... 19
OpenManage Enterprise – Modular Edition................................................................................................................20
OpenManage Enterprise..................................................................................................................................................20
Chapter 3: Key integration concepts............................................................................................ 21
Base URI...............................................................................................................................................................................21
OEM scheme................................................................................................................................................................. 21
Redfish scheme............................................................................................................................................................23
Security................................................................................................................................................................................23
Authentication....................................................................................................................................................................24
Authorization...................................................................................................................................................................... 24
Resource addressing.........................................................................................................................................................27
Resource operations......................................................................................................................................................... 27
Security considerations....................................................................................................................................................28
Data filtering.......................................................................................................................................................................28
Data sorting........................................................................................................................................................................ 28
Data pagination..................................................................................................................................................................29
Request headers................................................................................................................................................................29
Response codes.................................................................................................................................................................29
Response headers............................................................................................................................................................. 30
Chapter 4: Application settings................................................................................................... 32
Network............................................................................................................................................................................... 32
/api/ApplicationService/Network...........................................................................................................................32
/api/ApplicationService/Network/WebServerConfiguration.......................................................................... 33
/api/ApplicationService/Network/TimeConfiguration...................................................................................... 34
/api/ApplicationService/Network/TimeZones.................................................................................................... 35
/api/ApplicationService/Network/ProxyConfiguration.................................................................................... 36
Security and user management......................................................................................................................................37
/api/AccountService.................................................................................................................................................. 37
/api/AccountService/Accounts.............................................................................................................................. 40
/api/AccountService/Accounts(Id)....................................................................................................................... 42
/api/AccountService/Accounts(userId)/Permissions....................................................................................... 44
/api/AccountService/Actions/AccountService.GetPrivileges........................................................................ 45
/api/AccountService/Actions/AccountService.GetPrivilegesForUser......................................................... 45
/api/AccountService/Actions/AccountService.GetUserDetail.......................................................................46
/api/AccountService/Actions/AccountService.Enable.....................................................................................46
/api/AccountService/Actions/AccountService.Disable.................................................................................... 47
Contents
Contents 3