Add a New Group

Request Parameters

Parameter

Description

Valid values

Note

description

Group description

Required parameter: no

id

Group identifier

Digits, latin characters, and the following symbols: ‘_’, ‘-’, ‘.’

Required parameter: no.

If not set, an ID will be generated automatically.

name

Group name

Required parameter: yes

parent-group

Parent group identifier

Required parameter:
no—for full-rights administrators
yes—for group administrators

The parent-group parameter is obligatory for group creation by a user with group administrator rights.

 

Request Example

http://192.168.1.1:9080/api/groups/add.ds?id=1001&name=group4&parent-group=1&description=new

XML and JSON response structure examples are described below.

 

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1558521889" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <group id="1001"/>
</drweb-es-api>

 

Description of XML Response Parameters

The <group /> element contains information about the created group.

The <group /> element attribute:

Attribute

Description

id

Group identifier

 

JSON Response Structure

{ "head": {
    "status": true,

    "timestamp": 1558521971,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "id": "1001"}}

 

Description of JSON Response Parameters

The data block contains information on the created group.

The data block element:

Field name

Description

id

Identifier of created group