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/D6AC-25E5-081F-417D-A06A/sites/74bb4afb-1ad9-4426-94e8-2d98726058ad/groups/8910a62f-9b62-45b7-915f-ec5bf2db3167
|
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": 32,
"GroupCode": "-722958623",
"GroupId": "532b329f-d7d3-441d-b29a-efa5b4dc7816",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "ead648a5-1d1f-40fe-84c1-5b6bc338211b",
"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>32</Endpoints>
<GroupCode>-722958623</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>532b329f-d7d3-441d-b29a-efa5b4dc7816</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>ead648a5-1d1f-40fe-84c1-5b6bc338211b</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>