Reference Guide

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