API Guide

Chapter 1: About this document...................................................................................................13
Chapter 2: Overview.................................................................................................................... 14
RESTful application programming interface................................................................................................................14
OData.................................................................................................................................................................................... 14
JSON data............................................................................................................................................................................14
HTTPS communication..................................................................................................................................................... 14
OpenManage Enterprise - Modular Edition................................................................................................................. 15
OpenManage Enterprise...................................................................................................................................................15
Chapter 3: Key integration concepts............................................................................................ 16
Base URI...............................................................................................................................................................................16
OEM scheme.................................................................................................................................................................16
Redfish scheme............................................................................................................................................................ 18
Security................................................................................................................................................................................ 18
Authentication.....................................................................................................................................................................19
Authorization.......................................................................................................................................................................19
Resource addressing.........................................................................................................................................................22
Resource operations.........................................................................................................................................................22
Security considerations....................................................................................................................................................23
Data filtering....................................................................................................................................................................... 23
Data sorting........................................................................................................................................................................ 23
Data pagination.................................................................................................................................................................. 23
Request headers................................................................................................................................................................24
Response codes.................................................................................................................................................................24
Response headers............................................................................................................................................................. 25
Chapter 4: Application settings................................................................................................... 26
Network............................................................................................................................................................................... 26
/api/ApplicationService/Network...........................................................................................................................26
/api/ApplicationService/Network/CurrentAddressConfiguration.................................................................. 27
/api/ApplicationService/Network/AddressConfiguration................................................................................ 28
/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....................................................................................... 43
/api/AccountService/Actions/AccountService.Enable.....................................................................................43
/api/AccountService/Actions/AccountService.Disable....................................................................................44
/api/AccountService/Actions/AccountService.Delete..................................................................................... 44
Contents
Contents 3