POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups
Creates a group under a given GSM site.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
The GSM console keycode. |
string |
Required |
| siteId |
The site identifier. |
string |
Required |
Body Parameters
Additional information for creating a new group.
CreateGroupRequestModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| GroupName |
The name of the group. Maximum of 50 characters is allowed. |
string |
Required |
| GroupDescription |
The description of the group. Maximum of 50 characters is allowed. |
string |
Required |
| PolicyId |
The id of the policy applied to the group. If not specified, the default policy will be applied. |
string |
None. |
Sample Request
{
"GroupName": "Test Group",
"GroupDescription": "Description of test group",
"PolicyId": "aa2f98b3-e70b-484d-b239-af345f38dba8"
}
<CreateGroupRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupDescription>Description of test group</GroupDescription> <GroupName>Test Group</GroupName> <PolicyId>aa2f98b3-e70b-484d-b239-af345f38dba8</PolicyId> </CreateGroupRequestModel>
Response Information
Resource Description
Information about the created group.
CreateGroupResponseModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| GroupId |
The id of the group that has been created. |
string |
None. |
Sample Response
{
"GroupId": "9d1681a2-3598-46b5-9bcf-f9395d0c241d"
}
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <GroupId>9d1681a2-3598-46b5-9bcf-f9395d0c241d</GroupId> </CreateGroupResponseModel>