API Guide

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