API Guide

Table Of Contents
Example
response body
{
"@odata.context": "$metadata#GroupService.Group/$entity",
"@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:15:01.746",
"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 108. Attributes
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.
Groups 293