метод REST scope: documentgenerator

documentgenerator.role.get

Получить роль по идентификатору

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

Описание

Метод documentgenerator.role.get возвращает информацию о роли и ее правах доступа.

Параметры

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

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

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

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

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"id":9}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.role.get

Ответ

HTTP-статус: 200

{
    "result": {
        "role": {
            "id": 9,
            "name": "Редакторы своих шаблонов",
            "code": "DOCGEN_TEMPLATE_EDITORS",
            "permissions": {
                "settings": {
                    "modify": ""
                },
                "templates": {
                    "modify": "A"
                },
                "documents": {
                    "modify": "X",
                    "view": "X"
                }
            }
        }
    },
    "time": {
        "start": 1774014973,
        "finish": 1774014974.093322,
        "duration": 1.0933220386505127,
        "processing": 0,
        "date_start": "2026-03-20T16:56:13+03:00",
        "date_finish": "2026-03-20T16:56:14+03:00",
        "operating_reset_at": 1774015574,
        "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 0 You do not have permissions to modify settings
403 DOCGEN_ACCESS_ERROR Your plan does not support this operation

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

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