Добавить роль documentgenerator.role.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
documentgeneratorКто может выполнять метод: пользователь с правом на изменение настроек генератора документов
Метод documentgenerator.role.add добавляет новую роль.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Поля роли (подробное описание) |
Параметр fields
|
Название |
Описание |
|
name* |
Название роли |
|
code |
Символьный код роли |
|
permissions |
Права роли (подробное описание). Ключи внутри
Если передать ключи в нижнем регистре, роль сохранится, но права будут пустыми. |
Объект permissions
|
Название |
Описание |
|
SETTINGS |
Права на настройки (подробное описание) |
|
TEMPLATES |
Права на шаблоны (подробное описание) |
|
DOCUMENTS |
Права на документы (подробное описание) |
Объект settings
|
Название |
Описание |
|
MODIFY |
Уровень доступа к настройкам. Возможные значения:
|
Объект templates
|
Название |
Описание |
|
MODIFY |
Уровень доступа к шаблонам. Возможные значения:
|
Объект 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
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"
}
}
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/documentgenerator.role.add
// 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 RoleAddResult = {
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<RoleAddResult>({
method: 'documentgenerator.role.add',
params: {
fields: {
name: 'Template Editors',
code: 'DOCGEN_TEMPLATE_EDITORS',
permissions: {
SETTINGS: {
MODIFY: '',
},
TEMPLATES: {
MODIFY: 'D',
},
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('Added role:', result.role.id, result.role.name)
}
} 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 addRole() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'documentgenerator.role.add',
params: {
fields: {
name: 'Template Editors',
code: 'DOCGEN_TEMPLATE_EDITORS',
permissions: {
SETTINGS: {
MODIFY: '',
},
TEMPLATES: {
MODIFY: 'D',
},
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('Added role:', result.role.id, result.role.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addRole)
</script>
try {
$response = $b24Service->core->call(
'documentgenerator.role.add',
[
'fields' => [
'name' => 'Редакторы шаблонов',
'code' => 'DOCGEN_TEMPLATE_EDITORS',
'permissions' => [
'SETTINGS' => [
'MODIFY' => '',
],
'TEMPLATES' => [
'MODIFY' => 'D',
],
'DOCUMENTS' => [
'MODIFY' => 'X',
'VIEW' => 'X',
],
],
],
]
);
$result = $response->getResponseData()->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'documentgenerator.role.add',
{
fields: {
name: 'Редакторы шаблонов',
code: 'DOCGEN_TEMPLATE_EDITORS',
permissions: {
SETTINGS: {
MODIFY: ''
},
TEMPLATES: {
MODIFY: 'D'
},
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.add',
[
'fields' => [
'name' => 'Редакторы шаблонов',
'code' => 'DOCGEN_TEMPLATE_EDITORS',
'permissions' => [
'SETTINGS' => [
'MODIFY' => '',
],
'TEMPLATES' => [
'MODIFY' => 'D',
],
'DOCUMENTS' => [
'MODIFY' => 'X',
'VIEW' => 'X',
],
],
],
]
);
print_r($result);
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "documentgenerator.role.add", b24.Params{
"fields": b24.Params{
"name": "Редакторы шаблонов",
"code": "DOCGEN_TEMPLATE_EDITORS",
"permissions": b24.Params{
"SETTINGS": b24.Params{
"MODIFY": "",
},
"TEMPLATES": b24.Params{
"MODIFY": "D",
},
"DOCUMENTS": b24.Params{
"MODIFY": "X",
"VIEW": "X",
},
},
},
})
if err != nil {
return fmt.Errorf("documentgenerator.role.add: %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": "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 |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
role |
Данные созданной роли (подробное описание) |
Объект role
|
Название |
Описание |
|
id |
Идентификатор роли |
|
name |
Название роли |
|
code |
Символьный код роли |
|
permissions |
Права роли (подробное описание) |
Объект permissions
|
Название |
Описание |
|
settings |
Права на настройки (подробное описание) |
|
templates |
Права на шаблоны (подробное описание) |
|
documents |
Права на документы (подробное описание) |
Объект settings
|
Название |
Описание |
|
modify |
Уровень доступа к настройкам
|
Объект templates
|
Название |
Описание |
|
modify |
Уровень доступа к шаблонам
|
Объект documents
|
Название |
Описание |
|
modify |
Уровень доступа на изменение документов
|
|
view |
Уровень доступа на просмотр документов
|
Обработка ошибок
HTTP-статус: 400, 403
{
"error": "100",
"error_description": "Could not find value for parameter {fields}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Could not find value for parameter |
Обязательный параметр |
|
|
|
Не заполнено обязательное поле "NAME" |
Не передано обязательное поле |
|
|
|
You do not have permissions to modify settings |
Недостаточно прав на изменение настроек генератора документов |
|
|
|
Your plan does not support this operation |
На тарифе недоступна функция разграничения прав для генератора документов |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |