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/E58B-2F08-7153-4DBB-8FE1/sites/3411b402-a210-47fc-b166-5582cd60477b/groups/314ee6f1-c81e-4009-b618-5e488d3af2b6
|
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": 10,
"GroupCode": "-992714144",
"GroupId": "4845f6a1-9484-4381-81f9-7fc9c11869bd",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "0260518b-e7c2-4390-8b9d-db4c7798037b",
"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>10</Endpoints>
<GroupCode>-992714144</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>4845f6a1-9484-4381-81f9-7fc9c11869bd</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>0260518b-e7c2-4390-8b9d-db4c7798037b</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>