Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide

PDF

GET method for Groups

This method returns a list of groups.

Description
Returns a list of groups.
Privilege
VIEW
HTTP response codes
200
Example response body 
{
  "@odata.context": "$metadata#Collection(GroupService.Group)",
  "@odata.count": 1,
  "value": [
    {
      "@odata.id": "/api/GroupService/Groups(64)",
      "Id": 64,
      "Name": "All Devices",
      "Description": "Group associated to all devices.",
      "GlobalStatus": 5000,
      "ParentId": 0,
      "CreationTime": "2017-06-08 18:48:27.069",
      "UpdatedTime": "2017-06-08 21:05:01.778",
      "CreatedBy": "system",
      "UpdatedBy": "",
      "Visible": true,
      "DefinitionId": 500,
      "DefinitionDescription": "Root group for all Types of Devices.",
      "TypeId": 2000,
      "MembershipTypeId": 24,
      "Devices": [
        {
          "@odata.id": "/api/GroupService/Groups(64)/Devices"
        }
      ],
      "AllLeafDevices": [
        {
          "@odata.id": "/api/GroupService/Groups(64)/AllLeafDevices"
        }
      ],
      "GroupHierarchy": [
        {
          "@odata.id": "/api/GroupService/Groups(64)/GroupHierarchy"
        }
      ],
      "SubGroups": [
        {
          "@odata.id": "/api/GroupService/Groups(64)/SubGroups"
        }
      ],
      "GroupDevicesSummary": [
        {
          "@odata.id": "/api/GroupService/Groups(64)/GroupDevicesSummary"
        }
      ]
    }
  ]
}
Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name Description
Id ID of the group.
Name Name of the group.
Description Description of the group.
GlobalStatus Global status of the group. Indicates the health of the group.
ParentId Parent ID of the group. If the group is a root group, ParentId is 0.
CreationTime Date and time when the group was created.
UpdatedTime Date and time when the group was updated.
CreatedBy User who created the group.
UpdatedBy User who last updated the group.
Visible Visibility of the group.
DefinitionId Definition ID of the group.
DefinitionDescription Definition description of the group.
TypeId Group type.
  • 1000 — Internal
  • 2000 — Predefined
  • 3000 — User defined
  • 4000 — Discovery defined
  • 5000 — MCM group
MembershipTypeId Group membership type.
  • 12 — Static
  • 24 — Dynamic
Link
Devices Group link to list group devices.
AllLeafDevices Group link to list all group sub groups devices.
GroupHierarchy Group link to list the group hierarchy.
SubGroup Group link to display the list of sub groups of this group.
GroupDevicesSummary Group link to display a summary of all group devices.
Table 2. FiltersThis table lists the filters that this method supports.
Attribute name Description
Top Top records to return. Default value is 100.
Skip Max records to skip. Default value is 0.
Name Filter by group name.
Description Filter by group description.
Type Filter by group type.
MembershipType Filter by group membership type.
GlobalStatus Filter by group global status.
DefinitionId Filter by group definition ID.
DefinitionDescription Filter by group definition description.
Visible Filter by group visibility.
CreatedBy Filter by the entity that created the group.
UpdatedBy Filter by the entity that updated the group.
CreationTimeBegin Filter by the start-time when the group was created.
CreationTimeEnd Filter by the end-time when the group was created.
UpdatedTimeBegin Filter by the start-time when the group was updated.
UpdatedTimeEnd Filter by the end-time when the group was updated.

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\