метод REST scope: documentgenerator

documentgenerator.role.add

Добавить роль

Кто может выполнять: пользователь с правом на изменение настроек генератора документов

Описание

Метод documentgenerator.role.add добавляет новую роль.

Параметры

fields object обязательный

Параметр fields

name string обязательный

Название роли

code string необязательный

Символьный код роли

permissions object необязательный

Права роли (подробное описание).

Ключи внутри permissions чувствительны к регистру. Передавайте только в верхнем регистре:
- SETTINGS, TEMPLATES, DOCUMENTS
- MODIFY, VIEW

Если передать ключи в нижнем регистре, роль сохранится, но права будут пустыми.

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "fields": {
      "name": "Редакторы шаблонов",
      "code": "DOCGEN_TEMPLATE_EDITORS",
      "permissions": {
        "SETTINGS": {
          "MODIFY": ""
        },
        "TEMPLATES": {
          "MODIFY": "D"
        },
        "DOCUMENTS": {
          "MODIFY": "X",
          "VIEW": "X"
        }
      }
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.add

Ответ

HTTP-статус: 200

{
    "result": {
        "role": {
            "id": 9,
            "name": "Редакторы шаблонов",
            "code": "DOCGEN_TEMPLATE_EDITORS",
            "permissions": {
                "settings": {
                    "modify": ""
                },
                "templates": {
                    "modify": "D"
                },
                "documents": {
                    "modify": "X",
                    "view": "X"
                }
            }
        }
    },
    "time": {
        "start": 1774008850,
        "finish": 1774008850.528288,
        "duration": 0.5282878875732422,
        "processing": 0,
        "date_start": "2026-03-20T15:14:10+03:00",
        "date_finish": "2026-03-20T15:14:10+03:00",
        "operating_reset_at": 1774009450,
        "operating": 0
    }
}

Возвращаемые данные

result object

Корневой элемент ответа (подробное описание)

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {fields}"
}
Код Описание Значение
400 100 Could not find value for parameter {fields}
400 BX_EMPTY_REQUIRED Не заполнено обязательное поле "NAME"
400 0 You do not have permissions to modify settings
403 DOCGEN_ACCESS_ERROR Your plan does not support this operation

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.