GET api/Groups/{id}/Hierarchy?includeUnitSerials={includeUnitSerials}&maxDepth={maxDepth}
Returns the group and all its children in a hierarchy structure
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
the groups Id |
integer32 |
Required |
| includeUnitSerials |
if true, will return the serialnumbers of units in the groups |
boolean |
Default value is False |
| maxDepth |
Optional. If not null, will only return this many layers down the group hierarchy - else will return all child groups. Default is null |
integer32 |
None. |
Body Parameters
None.
Response Information
Resource Description
Returns the group and all its children in a hierarchy structure
GroupHierarchyModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Children |
Hierarchical structure. List of Child groups. Will be empty if this is a leaf group |
Collection of GroupHierarchyModel |
None. |
| Id |
Id of the group |
integer32 |
None. |
| Name |
Name of the group |
string |
None. |
| Units |
A list of units in this group. Will be an empty array if no units are directly in this group, and the request for this model requested UnitSerialNumbers. Will be null if the request for this model did not request UnitSerialNumbers. |
Collection of string |
Null values possible. |
| ParentId |
the Id of this groups parent |
integer32 |
None. |
Response Formats
application/json, text/json
Sample not available.