White Papers

16 REST API Guide  OpenManage Essentials | Revision A02
In this POST operation, user has to provide the name and description of the group to be created in the payload.
Optionally, user can provide a list of device IDs to be added to the group in the payload.
Attribute Name
Description
Name
Name of the device group
Description
A short description of the device group
AddDevices
List of DeviceIDs to be added to the group
A sample payload is given here:
<RESTDeviceGroupEntry>
<Name>Group 1</Name>
<Description>Description of group</Description>
<AddDevices>
<int>1</int>
<int>2</int>
<int>3</int>
</AddDevices>
</RESTDeviceGroupEntry>
After successful completion, a new group is added with specified parameters and the newly added group
appears the device tree. If either the group name is empty or a group with same name
already exist, a corresponding error message is returned. User can add a group only under root node (All
Devices). Creation of subgroup and query driven groups are not possible. The devices bearing the IDs provided
(if any) in the payload will be added to the newly created group if they are already discovered in OME. If the
user provides device IDs which are invalid, an error message is returned only for those IDs and remaining
devices will be added to the group.
Only OmeAdministrators, OmePowerUsers, and OmeSiteAdministrators will have the permission to add new
device groups. In case of insufficient permissions, the operation will fail and returns an error message.
2.1.3 Modify Devices Group
The following URI allows user to add devices to and remove devices from a custom group. The devices to be
added to the group must be discovered in OME prior to adding to custom group. User can use this API to
rename the group and change description of the group.
<BASE_URI>/DeviceGroups/{groupid}
Operation: PUT
For this operation, a user must enter group ID in URI and list of IDs of devices to be added or removed in the
payload XML.