Reference Guide

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