метод REST scope: documentgenerator

documentgenerator.role.update

Изменить роль

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

Описание

Метод documentgenerator.role.update обновляет роль по идентификатору.

Параметры

id integer обязательный

Идентификатор роли.

Получить идентификатор можно после создания роли или методом получения списка ролей

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 '{
    "id": 9,
    "fields": {
      "name": "Редакторы своих шаблонов",
      "permissions": {
        "SETTINGS": {
          "MODIFY": ""
        },
        "TEMPLATES": {
          "MODIFY": "A"
        },
        "DOCUMENTS": {
          "MODIFY": "X",
          "VIEW": "X"
        }
      }
    }
  }' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.update

Ответ

HTTP-статус: 200

{
    "result": {
        "role": {
            "id": 9,
            "name": "Редакторы своих шаблонов",
            "code": "DOCGEN_TEMPLATE_EDITORS",
            "permissions": {
                "settings": {
                    "modify": ""
                },
                "templates": {
                    "modify": "A"
                },
                "documents": {
                    "modify": "X",
                    "view": "X"
                }
            }
        }
    },
    "time": {
        "start": 1774014410,
        "finish": 1774014410.602927,
        "duration": 0.6029269695281982,
        "processing": 0,
        "date_start": "2026-03-20T16:46:50+03:00",
        "date_finish": "2026-03-20T16:46:50+03:00",
        "operating_reset_at": 1774015010,
        "operating": 0
    }
}

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

result object

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

time time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to modify settings"
}
Код Описание Значение
400 100 Bitrix\DocumentGenerator\Model\Role All parameters in the constructor must have real class type
400 100 Could not construct parameter {role}
400 100 Could not find value for parameter {fields}
400 0 You do not have permissions to modify settings
403 DOCGEN_ACCESS_ERROR Your plan does not support this operation

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

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