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......................................................................................................................................................................23
Authorization........................................................................................................................................................................24
Resource addressing...........................................................................................................................................................26
Resource operations............................................................................................................................................................27
Security considerations.......................................................................................................................................................27
Data filtering.........................................................................................................................................................................27
Data sorting..........................................................................................................................................................................28
Data pagination....................................................................................................................................................................28
Request headers..................................................................................................................................................................28
Response codes...................................................................................................................................................................29
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