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/CB57-6AA4-8C88-42B0-8A66/sites/63acaeb8-a113-4535-a036-64ab83650214/groups/fbff41f9-2074-4d63-b6da-3aba449a758a
|
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": 19,
"GroupCode": "-738903993",
"GroupId": "85e3e043-ea40-4fea-bf68-0a7fc10bb768",
"GroupName": "Test Group 1",
"GroupDescription": "Description of test group 1",
"GroupPolicyId": "efb5c866-b447-4520-bf61-6239cbeb7abe",
"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>19</Endpoints>
<GroupCode>-738903993</GroupCode>
<GroupDescription>Description of test group 1</GroupDescription>
<GroupId>85e3e043-ea40-4fea-bf68-0a7fc10bb768</GroupId>
<GroupName>Test Group 1</GroupName>
<GroupPolicyId>efb5c866-b447-4520-bf61-6239cbeb7abe</GroupPolicyId>
<GroupPolicyName>Test Policy 1</GroupPolicyName>
</GetGroupsResponseModel_Group>
</Groups>
<TotalCount>1</TotalCount>
</GetGroupsResponseModel>