White Papers

Acknowledgements
3 REST API Guide–OpenManage Essentials
Contents
Revisions............................................................................................................................................................................. 2
Acknowledgements ............................................................................................................................................................. 2
Acronyms ............................................................................................................................................................................ 6
1 Key integration concepts .............................................................................................................................................. 7
Client Integration Overview ................................................................................................................................ 7
Base URI ............................................................................................................................................................ 7
Security ............................................................................................................................................................... 8
Authentication mechanisms ................................................................................................................................ 8
Resource addressing .......................................................................................................................................... 8
Resource operations .......................................................................................................................................... 8
Security considerations ...................................................................................................................................... 9
Data filtering and sorting ................................................................................................................................... 10
Data pagination................................................................................................................................................. 10
Request headers .............................................................................................................................................. 11
Response codes ............................................................................................................................................... 11
Response headers ........................................................................................................................................... 12
2 OpenManage Essentials-Specific Resource Model ................................................................................................... 13
Device Groups .................................................................................................................................................. 13
2.1.1 Access Device Groups ..................................................................................................................................... 13
2.1.2 Create Devices Group ...................................................................................................................................... 15
2.1.3 Modify Devices Group ...................................................................................................................................... 15
2.1.4 Delete Devices Group ...................................................................................................................................... 16
Devices ............................................................................................................................................................. 17
2.2.1 Devices by direct access .................................................................................................................................. 19
2.2.2 Delete Device ................................................................................................................................................... 19
2.2.3 Changed device information ............................................................................................................................. 20
2.3 Device inventory ............................................................................................................................................... 21
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 ............................................................................................................................................................. 22
2.3.6 Software inventory ............................................................................................................................................ 23
2.3.7 Agent information.............................................................................................................................................. 24
2.3.8 Contact information .......................................................................................................................................... 25