Users Guide

2 OME- Specific Resource Model
The following sub- sections represent a subset of the use cases that OME supports. The REST API support
and the operation support will be incrementally refined based on consumer feedback over multiple OME
releases. Also, see the data filtering/sorting and pagination
sections for patterns that can be used for
performing paged retrieval of large result sets in OME (for example, alerts, devices, and so on).
Also, the following sections have information on the minimal set of attributes required for data filtering
and sorting operations. The filtering can be enabled using a suffix such as
“<Resource URI>? <Attribute Name1>=<Value1> & <Attribute Name2>=<Value2>”
2.1 Device Groups
The following resource URI can be used to access groups in OME: <BASE_URI>/DeviceGroups.
Operations supported : GET
Attributes (filtering) : Id, Type, Name, RollupHealth, and DeviceCount
Attributes (sorting) : Name Asc (by default)
A GET operation on an URI retrieves the root group of the hierarchy (the ‘All Devices’ group). The
hierarchy can be recursively retrieved by retrieving the child groups and the devices under that root group.
Note: Only system and custom groups can be returned (device group types 2 and 4 respectively).
The attributes for each group are described in the following table.
Attribute Name
Description
Id
The unique identifier for the group.
Type
The type enumeration for the group.
Name
The name of the group.
Description
Description of the group.
RollupHealth
The rollup health enumeration for the group.
DeviceCount The total number of devices in the group.
The following resource URI can be used to retrieve the child groups of a specific group:
<BASE_URI>/DeviceGroups/<ID>/ChildGroups
12 REST API Guide – OpenManage Essentials | Revision A01