Developers Guide

Revision history..........................................................................................................................................................................3
Chapter 1: About this document.................................................................................................. 20
Chapter 2: Overview....................................................................................................................23
RESTful application programming interface............................................................................................................... 23
OData................................................................................................................................................................................... 23
JSON data...........................................................................................................................................................................23
HTTPS communication.................................................................................................................................................... 23
OpenManage Enterprise – Modular Edition................................................................................................................24
Importing licenses using APIs................................................................................................................................... 24
Exporting licenses using APIs................................................................................................................................... 24
Deleting licenses using APIs......................................................................................................................................24
OpenManage Enterprise.................................................................................................................................................. 24
Chapter 3: Key integration concepts........................................................................................... 26
Base URI.............................................................................................................................................................................. 26
OEM scheme................................................................................................................................................................ 26
Redfish scheme............................................................................................................................................................28
Security................................................................................................................................................................................29
Authentication....................................................................................................................................................................29
Authorization...................................................................................................................................................................... 30
Resource addressing........................................................................................................................................................ 33
Resource operations.........................................................................................................................................................33
Security considerations....................................................................................................................................................34
Performance considerations ..........................................................................................................................................34
Data filtering....................................................................................................................................................................... 34
Data sorting........................................................................................................................................................................ 34
Data pagination..................................................................................................................................................................35
Request headers................................................................................................................................................................35
Response codes.................................................................................................................................................................35
Response headers............................................................................................................................................................. 36
Chapter 4: Application settings................................................................................................... 38
Network............................................................................................................................................................................... 38
/api/ApplicationService/Network...........................................................................................................................38
/api/ApplicationService/Network/WebServerConfiguration.......................................................................... 39
/api/ApplicationService/Network/TimeConfiguration...................................................................................... 40
/api/ApplicationService/Network/TimeZones.....................................................................................................41
/api/ApplicationService/Network/ProxyConfiguration.................................................................................... 42
Security and user management..................................................................................................................................... 43
/api/AccountService.................................................................................................................................................. 43
/api/AccountService/Accounts.............................................................................................................................. 47
/api/AccountService/Accounts(Id)....................................................................................................................... 50
/api/AccountService/Accounts(userId)/Permissions....................................................................................... 53
Contents
4 Contents