White Papers

OpenManage Essentials-Specific Resource Model
33 REST API Guide–OpenManage Essentials
2.5 Device Group Hierarchy
Some consumers of the OpenManage Essentials REST API services will require the capability of retrieving
information that has changed since a particular point in time. The OpenManage Essentials server continuously
updates its database with new device information, new hierarchical information, and information that has been
deleted. OpenManage Essentials REST API consumers that want to implement a cache subsystem and need
the capability of retrieving information that has changed (or deleted) may be able to use the following set of
APIs.
The following URI can be used to retrieve the device group hierarchy currently managed by OpenManage
Essentials:
<BASE_URI>/DeviceGroupHierarchy
Operations Supported: GET
The attributes associated with the returned payload are described in the following table:
Attribute Name
Description
HierarchyAddedOrUpdatedTimestamp
The last timestamp for the device group to device group
hierarchy where an addition or update was performed.
HierarchyDeletedTimestamp
The last timestamp for the device group to device group
hierarchy timestamp where a deletion was performed.
DeviceGroupAddedOrUpdatedTimestamp
The last timestamp for the device groups where an
addition or updated was performed.
DeviceGroupDeletedTimestamp
The last timestamp for the device groups where a
deletion was performed.
DeviceToGroupAddedOrUpdatedTimestamp
The last timestamp for the device to device group
hierarchy where an addition or update was performed.
DeviceToGroupDeletedTimestamp
The last timestamp for the device groups where deletion
was performed.
DeviceGroups
A collection of the device groups that have changed
since the last specified
DeviceGroupAddedOrDeletedTimestamp. Each
entry of this collection corresponds to the definition in the
“Device Groups” section in this document.
DeviceGroupToDeviceGroup
A collection of device group to device group
relationships. This relationship is defined in a later table.
DeviceGroupToDevice
A collection of device group to device relationships. This
relationship is defined in a later table.
DeletedDeviceGroupToDeviceGroup
A collection of integers that define the device group to
device group identifiers that have been deleted since the
last HierarchyDeletedTimestamp was specified.
DeletedDeviceGroups
A collection of integers that define the device group
identifiers that have been deleted since the last
DeviceGroupDeletedTimestamp was specified.
DeletedDeviceGroupToDevice
A collection of integers that define the device group to
device identifiers that have been deleted since the last
DeviceToGroupDeletedTimestamp was specified.
The attributes associated with the individual entries of the DeviceGroupToDeviceGroup section of the
returned payload are described in the following table: