метод REST scope: documentgenerator

documentgenerator.role.list

Получить список ролей

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

Описание

Метод documentgenerator.role.list возвращает список ролей без детализации прав.

Параметры

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

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N — 1) * 50, где N — номер нужной страницы

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "roles": [
            {
                "id": 1,
                "name": "Администратор",
                "code": "ADMIN"
            },
            {
                "id": 3,
                "name": "Менеджер",
                "code": "MANAGER"
            },
            {
                "id": 9,
                "name": "Редакторы своих шаблонов",
                "code": "DOCGEN_TEMPLATE_EDITORS"
            }
        ]
    },
    "total": 3,
    "time": {
        "start": 1774015085,
        "finish": 1774015085.612552,
        "duration": 0.6125519275665283,
        "processing": 0,
        "date_start": "2026-03-20T16:58:05+03:00",
        "date_finish": "2026-03-20T16:58:05+03:00",
        "operating_reset_at": 1774015685,
        "operating": 0
    }
}

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

result object

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

total integer

Количество ролей в текущей выборке

time time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "You do not have permissions to modify settings"
}
Код Описание Значение
400 0 You do not have permissions to modify settings
403 DOCGEN_ACCESS_ERROR Your plan does not support this operation

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

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