White Papers

3 REST API Guide  OpenManage Essentials | Revision A02
Contents
Revisions............................................................................................................................................................................. 2
Introduction ......................................................................................................................................................................... 6
1 Key Integration Concepts ............................................................................................................................................. 7
1.1 Client Integration Overview ................................................................................................................................ 7
1.2 Base URI ............................................................................................................................................................ 7
1.3 Security ............................................................................................................................................................... 8
1.4 Authentication mechanisms ................................................................................................................................ 8
1.5 Resource addressing .......................................................................................................................................... 8
1.6 Resource operations .......................................................................................................................................... 9
1.7 Security considerations ...................................................................................................................................... 9
1.8 Data filtering and sorting ................................................................................................................................... 10
1.9 Data pagination ................................................................................................................................................. 10
1.10 Request headers .............................................................................................................................................. 11
1.11 Response codes ............................................................................................................................................... 11
1.12 Response headers ........................................................................................................................................... 12
2 OpenManage Essentials-Specific Resource Model ................................................................................................... 13
2.1 Device Groups .................................................................................................................................................. 13
2.1.1 Access Device Groups ..................................................................................................................................... 13
2.1.2 Create Devices Group ...................................................................................................................................... 15
2.1.3 Modify Devices Group ...................................................................................................................................... 16
2.1.4 Delete Devices Group ...................................................................................................................................... 17
2.2 Devices ............................................................................................................................................................. 18
2.2.1 Devices by direct access .................................................................................................................................. 21
2.2.2 Delete Device ................................................................................................................................................... 22
2.2.3 Changed device information ............................................................................................................................. 22
2.3 Device inventory ............................................................................................................................................... 23
2.3.1 Firmware ........................................................................................................................................................... 23
2.3.2 Processor .......................................................................................................................................................... 24
2.3.3 NICs .................................................................................................................................................................. 24
2.3.4 Operating systems ............................................................................................................................................ 24
2.3.5 Memory ............................................................................................................................................................. 25
2.3.6 Software inventory ............................................................................................................................................ 26