GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}
Gets information about a group.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
| groupId |
The group identifier. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/E619-2015-7A9F-4172-AAB3/sites/2b209b86-71ee-4f77-a103-8245fc33719e/groups/6a442341-e742-4177-9a89-14e2e8cab3cb
|
Body Parameters
None.
Response Information
Resource Description
Information about the desired group.
GetGroupsResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| TotalCount |
Total number of groups available. |
integer |
None. |
| Groups |
List of group details records. |
Collection of GetGroupsResponseModel_Group |
None. |
Sample Response
{
"TotalCount": 1,
"Groups": [
{
"Endpoints": 31,
"GroupCode": "-900642958",
"GroupId": "38bc36a8-5ff0-4e41-a4d8-f21e754b6a73",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "73822864-476a-487c-858c-58cfa32c0569",
"GroupPolicyName": "Test Policy 1"
}
]
}
<GetGroupsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
<Groups>
<GetGroupsResponseModel_Group>
<Endpoints>31</Endpoints>
<GroupCode>-900642958</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>38bc36a8-5ff0-4e41-a4d8-f21e754b6a73</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>73822864-476a-487c-858c-58cfa32c0569</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>