White Papers

3 REST API Guide  OpenManage Essentials | Revision A02
Contents
Revisions............................................................................................................................................................................. 2
Introduction ......................................................................................................................................................................... 5
1 Key Integration Concepts ............................................................................................................................................. 6
1.1 Client Integration Overview ................................................................................................................................ 6
1.2 Base URI ............................................................................................................................................................ 6
1.3 Security ............................................................................................................................................................... 7
1.4 Authentication mechanisms ................................................................................................................................ 7
1.5 Resource addressing .......................................................................................................................................... 7
1.6 Resource operations .......................................................................................................................................... 8
1.7 Security considerations ...................................................................................................................................... 9
1.8 Data filtering and sorting ..................................................................................................................................... 9
1.9 Data pagination................................................................................................................................................... 9
1.10 Request headers .............................................................................................................................................. 10
1.11 Response codes ............................................................................................................................................... 10
1.12 Response headers ........................................................................................................................................... 11
2 OpenManage Essentials-Specific Resource Model ................................................................................................... 12
2.1 Device Groups .................................................................................................................................................. 12
2.2 Devices ............................................................................................................................................................. 15
2.2.1 Devices by direct access .................................................................................................................................. 18
2.2.2 Changed device information ............................................................................................................................. 19
2.3 Device inventory ............................................................................................................................................... 20
2.3.1 Firmware ........................................................................................................................................................... 20
2.3.2 Processor .......................................................................................................................................................... 20
2.3.3 NICs .................................................................................................................................................................. 21
2.3.4 Operating systems ............................................................................................................................................ 21
2.3.5 Memory ............................................................................................................................................................. 22
2.3.6 Software inventory ............................................................................................................................................ 24
2.3.7 Agent information.............................................................................................................................................. 24
2.3.8 Contact information .......................................................................................................................................... 25
2.3.9 Device capabilities ............................................................................................................................................ 26
2.3.10 Warranty information .................................................................................................................................... 28
2.3.11 All inventory .................................................................................................................................................. 29