Создание группы

Параметры запроса

 

Параметр

Описание

Примечание

description

Описание группы

Обязательный параметр: нет

id

Идентификатор группы

Обязательный параметр: нет.

Если идентификатор не задан, то он будет сгенерирован автоматически.

Допустимые значения: цифры, буквы латинского алфавита, символы ‘_’, ‘-’, ‘.’

name

Название группы

Обязательный параметр: да

parent-group

Идентификатор родительской группы

Обязательный параметр:
нет — для администраторов с полными правами,
да — для администраторов групп

component-scanner

Отдельные компоненты.

Допустимые значения:

0 — компонент не должен быть установлен,

1 — компонент может быть установлен,

2 — компонент должен быть установлен.

Если в запросе задан параметр components, то будет использован он.

нет

component-office-control

component-spider-guard

component-spider-guard-servers

component-spider-mail

component-spider-gate

component-msoutlook-plugin

component-firewall

component-antispam

components

Набор компонентов, которые будут доступны на клиентской машине.

Допустимые значения: битовое поле (см. Приложение Б2. Коды компонентов).
Если параметр задан, в запросе нет необходимости задавать параметры для установки отдельных компонентов.

нет

 

Параметр parent-group обязателен при создании группы от имени пользователя с правами администратора групп.

 

Пример запроса

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

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

<drweb-es-api api_version="4.3.2" timestamp="1587993055" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
  <group id="1001"/>
</drweb-es-api>

 

Описание параметров ответного XML

Элемент <group /> содержит идентификатор созданной группы.

Атрибут элемента <group />:

Атрибут

Описание

id

Идентификатор группы

 

Ответ в формате JSON

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

    "timestamp": 1587993557,

    "api": {
      "version": 40302,
      "versionString": "4.3.2"},

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

      "version": "13.00.0.202005090",
      "uuid": "25cf53c0-885a-11ea-5c35-289def4dadcb"}},

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

 

Описание параметров ответного JSON

Блок data содержит идентификатор созданной группы.

Элемент блока data:

Название поля

Описание

id

Идентификатор группы