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/4C46-4BA8-ADAE-4A06-893A/sites/4f5e98e0-43b5-462f-90fc-bd0f6eb575e5/groups/1ac9e5cf-17ae-4637-b1e7-736887d855df
|
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": 66,
"GroupCode": "-465469433",
"GroupId": "82c76484-eb76-445b-b193-9f7af9981d14",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "e3b54275-d6a6-451b-8de5-ce4a3394b011",
"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>66</Endpoints>
<GroupCode>-465469433</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>82c76484-eb76-445b-b193-9f7af9981d14</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>e3b54275-d6a6-451b-8de5-ce4a3394b011</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>