White Papers

OpenManage Essentials-Specific Resource Model
24 REST API Guide–OpenManage Essentials
The attributes associated with each software entity instance are described in the following table:
Attribute Name
Description
Description
The description of the software entity.
Version
The version of the software entity.
Type
The type of the software entity.
The software type is described in the following table:
Type
Description
APAC
Application
APP
Systems management application
BIOS
BIOS
DRVR
Driver
FRMW
Firmware
2.3.7 Agent information
The following resource URI can be used to retrieve agent information associated with a specific device identified
by <DEVICE_ID>:
<DEVICE_BASE_URI>/<DEVICE_ID>/Agents
The attributes associated with the agent information are described in the following table:
Attribute Name
Description
AgentId
The unique identifier for the agent
Description
The description of the agent.
DeviceId
The device identifier associated with the agent.
Name
The name of the agent.
Status
The latest status reported by the agent.
URL
The management URL of the agent.
Version
The version of the agent.
Note—In the case of an OpenManage Server Administrator (OMSA) agent, the value of the URL is a concatenated list
of various URLs separated by the comma ‘,’ character. The consumer of this API will have to tokenize this output and
attempt a web connection to each of the URLs to determine which URL is responsive before surfacing the URL to the
actual consumer. The following is an example of the URL for OMSA as returned in the REST XML payload: