Изменить роль documentgenerator.role.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: documentgenerator

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

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

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

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

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

fields*
object

Набор полей для обновления (подробное описание)

Параметр fields

Название
тип

Описание

name
string

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

code
string

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

permissions
object

Новый набор прав роли (подробное описание).

Важно

Ключи внутри permissions чувствительны к регистру. Передавайте только в верхнем регистре:

  • SETTINGS, TEMPLATES, DOCUMENTS
  • MODIFY, VIEW

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

Объект permissions

Название
тип

Описание

SETTINGS
object

Права на настройки (подробное описание)

TEMPLATES
object

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

DOCUMENTS
object

Права на документы (подробное описание)

Объект settings

Название
тип

Описание

MODIFY
string

Уровень доступа к настройкам. Возможные значения:

  • "" — нет доступа
  • X — полный доступ

Объект templates

Название
тип

Описание

MODIFY
string

Уровень доступа к шаблонам. Возможные значения:

  • "" — нет доступа
  • A — только свои элементы
  • D — свои и коллег по отделу
  • X — полный доступ

Объект documents

Название
тип

Описание

MODIFY
string

Уровень доступа на изменение документов. Возможные значения:

  • "" — нет доступа
  • X — полный доступ

VIEW
string

Уровень доступа на просмотр документов. Возможные значения:

  • "" — нет доступа
  • X — полный доступ

Примеры кода

Как использовать примеры в документации

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
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"
        }
      }
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/documentgenerator.role.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type RoleUpdateResult = {
  role: {
    id: number
    name: string
    code: string
    permissions: {
      settings: { modify: string }
      templates: { modify: string }
      documents: { modify: string; view: string }
    }
  }
}

try {
  const response = await $b24.actions.v2.call.make<RoleUpdateResult>({
    method: 'documentgenerator.role.update',
    params: {
      id: 9,
      fields: {
        name: 'Editors of own templates',
        permissions: {
          SETTINGS: {
            MODIFY: '',
          },
          TEMPLATES: {
            MODIFY: 'A',
          },
          DOCUMENTS: {
            MODIFY: 'X',
            VIEW: 'X',
          },
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.role.id, result.role.name, result.role.code)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateRole() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'documentgenerator.role.update',
        params: {
          id: 9,
          fields: {
            name: 'Editors of own templates',
            permissions: {
              SETTINGS: {
                MODIFY: '',
              },
              TEMPLATES: {
                MODIFY: 'A',
              },
              DOCUMENTS: {
                MODIFY: 'X',
                VIEW: 'X',
              },
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.role.id, result.role.name, result.role.code)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateRole)
</script>
try {
    $response = $b24Service->core->call(
        'documentgenerator.role.update',
        [
            'id' => 9,
            'fields' => [
                'name' => 'Редакторы своих шаблонов',
                'permissions' => [
                    'SETTINGS' => [
                        'MODIFY' => '',
                    ],
                    'TEMPLATES' => [
                        'MODIFY' => 'A',
                    ],
                    'DOCUMENTS' => [
                        'MODIFY' => 'X',
                        'VIEW' => 'X',
                    ],
                ],
            ],
        ]
    );

    $result = $response->getResponseData()->getResult();
    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}
BX24.callMethod(
    'documentgenerator.role.update',
    {
        id: 9,
        fields: {
            name: 'Редакторы своих шаблонов',
            permissions: {
                SETTINGS: {
                    MODIFY: ''
                },
                TEMPLATES: {
                    MODIFY: 'A'
                },
                DOCUMENTS: {
                    MODIFY: 'X',
                    VIEW: 'X'
                }
            }
        }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
        }
        else
        {
            console.log(result.data());
        }
    }
);
require_once('crest.php');

$result = CRest::call(
    'documentgenerator.role.update',
    [
        'id' => 9,
        'fields' => [
            'name' => 'Редакторы своих шаблонов',
            'permissions' => [
                'SETTINGS' => [
                    'MODIFY' => '',
                ],
                'TEMPLATES' => [
                    'MODIFY' => 'A',
                ],
                'DOCUMENTS' => [
                    'MODIFY' => 'X',
                    'VIEW' => 'X',
                ],
            ],
        ],
    ]
);

print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.role.update", b24.Params{
	"id": 9,
	"fields": b24.Params{
		"name": "Редакторы своих шаблонов",
		"permissions": b24.Params{
			"SETTINGS": b24.Params{
				"MODIFY": "",
			},
			"TEMPLATES": b24.Params{
				"MODIFY": "A",
			},
			"DOCUMENTS": b24.Params{
				"MODIFY": "X",
				"VIEW":   "X",
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("documentgenerator.role.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "role".
raw, ok := b24.Unwrap(res.Result, "role")
if !ok {
	return fmt.Errorf("в ответе нет ключа role")
}

var item struct {
	ID   b24.ID `json:"id"`
	Name string `json:"name"`
	Code string `json:"code"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name)

Обработка ответа

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

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

Объект result

Название
тип

Описание

role
object

Данные обновленной роли (подробное описание)

Объект role

Название
тип

Описание

id
integer

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

name
string

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

code
string

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

permissions
object

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

Объект permissions

Название
тип

Описание

settings
object

Права на настройки (подробное описание)

templates
object

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

documents
object

Права на документы (подробное описание)

Объект settings

Название
тип

Описание

modify
string

Уровень доступа к настройкам
Возможные значения:

  • "" — нет доступа
  • X — полный доступ

Объект templates

Название
тип

Описание

modify
string

Уровень доступа к шаблонам
Возможные значения:

  • "" — нет доступа
  • A — только свои элементы
  • D — свои и коллег по отделу
  • X — полный доступ

Объект documents

Название
тип

Описание

modify
string

Уровень доступа на изменение документов
Возможные значения:

  • "" — нет доступа
  • X — полный доступ

view
string

Уровень доступа на просмотр документов
Возможные значения:

  • "" — нет доступа
  • X — полный доступ

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

HTTP-статус: 400, 403

{
    "error": "0",
    "error_description": "You do not have permissions to modify settings"
}

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Статус

Код

Описание

Значение

400

100

Bitrix\DocumentGenerator\Model\Role All parameters in the constructor must have real class type

Не передан обязательный параметр id

400

100

Could not construct parameter

Передан несуществующий параметр id

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

На тарифе недоступна функция разграничения прав для генератора документов

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение