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/AB6D-E8CC-9166-4FDC-9ECF/sites/61a6ca5f-5f04-4738-bf81-192997dfadcb/groups/a1a5b607-ced7-4fc9-919b-9f456114438a
|
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": 6,
"GroupCode": "-133101404",
"GroupId": "df433ba7-19c5-49aa-af59-ff680ab9232b",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "d1e895f7-dd2f-4842-a7c9-d13d4cd11707",
"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>6</Endpoints>
<GroupCode>-133101404</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>df433ba7-19c5-49aa-af59-ff680ab9232b</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>d1e895f7-dd2f-4842-a7c9-d13d4cd11707</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>