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/6C13-73E5-9293-4C57-B4C9/sites/c2be9ba9-4ec1-44d3-abf7-94a4792422e5/groups/6ba35421-856a-487a-b900-15dc72a26aa2
|
Body Parameters
None.
Response Information
Resource Description
Information about the desired group.
GetGroupsResponseModelName | 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": 84, "GroupCode": "-641997065", "GroupId": "ce4e90ff-5f2f-40a1-b80c-a41658f4aa8e", "GroupName": "Test Group 1", "GroupDescription": "Description of test group 1", "GroupPolicyId": "18a285a9-5d4a-4140-9a51-4e4573694b28", "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>84</Endpoints> <GroupCode>-641997065</GroupCode> <GroupDescription>Description of test group 1</GroupDescription> <GroupId>ce4e90ff-5f2f-40a1-b80c-a41658f4aa8e</GroupId> <GroupName>Test Group 1</GroupName> <GroupPolicyId>18a285a9-5d4a-4140-9a51-4e4573694b28</GroupPolicyId> <GroupPolicyName>Test Policy 1</GroupPolicyName> </GetGroupsResponseModel_Group> </Groups> <TotalCount>1</TotalCount> </GetGroupsResponseModel>