Параметры запроса
Параметр
|
Описание
|
Допустимые значения
|
Примечание
|
description
|
Описание группы
|
–
|
Обязательный параметр: нет
|
id
|
Идентификатор группы
|
Цифры, буквы латинского алфавита, символы ‘_’, ‘-’, ‘.’
|
Обязательный параметр: нет.
Если идентификатор не задан, то он будет сгенерирован автоматически.
|
name
|
Название группы
|
–
|
Обязательный параметр: да
|
parent-group
|
Идентификатор родительской группы
|
–
|
Обязательный параметр:
нет — для администраторов с полными правами,
да — для администраторов групп
|

|
Параметр parent-group обязателен при создании группы от имени пользователя с правами администратора групп.
|
Пример запроса
http://192.168.1.1:9080/api/groups/add.ds?id=1001&name=group4&parent-group=1&description=new
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<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>
|
Описание параметров ответного XML
Элемент <group /> содержит информацию о созданной группе.
Атрибут элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы
|
Ответ в формате JSON
{ "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"}}
|
Описание параметров ответного JSON
Блок data содержит информацию о созданной группе.
Элемент блока data:
Название поля
|
Описание
|
id
|
Идентификатор созданной группы
|
|