Reference Guide

3 REST API Guide – OpenManage Essentials | Revision A02
Table of 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 :< BASE_URI>/Devices ..................................................................................................... 18
2.2.2 Changed Device Information .........................................................................................................................................19
2.3 Device Inventory ............................................................................................................................................................... 20
2.3.1 Firmware .............................................................................................................................................................................. 21
2.3.2 Processor ............................................................................................................................................................................ 21
2.3.3 NICs ..................................................................................................................................................................................... 22
2.3.4 Operating Systems ........................................................................................................................................................... 22
2.3.5 Memory .............................................................................................................................................................................. 23
2.3.6 Software Inventory ........................................................................................................................................................... 25
2.3.7 Agent Information ............................................................................................................................................................ 26
2.3.8 Contact Information ........................................................................................................................................................ 27
2.3.9 Device Capabilities ........................................................................................................................................................... 27
2.3.10 Warranty Information ................................................................................................................................................. 29