POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups

Creates a group under a given GSM site.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

Body Parameters

Additional information for creating a new group.

CreateGroupRequestModel
NameDescriptionTypeAdditional 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": "4765d7a9-826c-442e-8bc2-599ad09fac66"
}                    
<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>4765d7a9-826c-442e-8bc2-599ad09fac66</PolicyId>
</CreateGroupRequestModel>                    

Response Information

Resource Description

Information about the created group.

CreateGroupResponseModel
NameDescriptionTypeAdditional Information
GroupId

The id of the group that has been created.

string

None.

Sample Response

{
  "GroupId": "3c7b6aa0-ae9b-45d8-b3c0-7662975ae860"
}                    
<CreateGroupResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <GroupId>3c7b6aa0-ae9b-45d8-b3c0-7662975ae860</GroupId>
</CreateGroupResponseModel>