Изменить шаблон documentgenerator.template.update

Scope: documentgenerator

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

Метод documentgenerator.template.update обновляет существующий шаблон.

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

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

Название
тип

Описание

id*
integer

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

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

fields*
object

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

Параметр fields

Название
тип

Описание

name
string

Название шаблона

file
file

Новый файл шаблона. Можно передать тремя способами:

  • строкой base64
  • массивом ["имя_файла.docx","base64_контент"]
  • как файл multipart/form-data

Частые кейсы и сценарии

numeratorId
integer

Идентификатор нумератора

region
string

Регион шаблона, например ru

code
string

Символьный код шаблона

users
array

Пользователи, у которых будет доступ к шаблону.

Возможные значения:

  • U{id} — пользователь
  • G{id} — группа пользователей
  • AU — все авторизованные пользователи
  • UA — все пользователи
  • D{id} — отдел
  • DR{id} — отдел с подотделами
  • SG{id} — рабочая группа или проект
  • SG{id}_A — владелец рабочей группы или проекта
  • SG{id}_E — модераторы рабочей группы или проекта
  • SG{id}_K — все члены рабочей группы или проекта

providers
array

Список провайдеров данных

active
char

Активность. Возможные значения:

  • Y — активен
  • N — не активен

withStamps
char

Подставлять печати и подписи. Возможные значения:

  • Y — да
  • N — нет

sort
integer

Индекс сортировки

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":57,"fields":{"name":"SUPPLY_CONTRACT_NEW Template","numeratorId":3,"code":"REST_TEMPLATE","users":["U503"],"sort":700}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.update
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":57,"fields":{"name":"SUPPLY_CONTRACT_NEW Template","numeratorId":3,"code":"REST_TEMPLATE","users":["U503"],"sort":700},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.update
        
try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.update',
                {
                    id: 57,
                    fields: {
                        name: 'SUPPLY_CONTRACT_NEW Template',
                        numeratorId: 3,
                        code: 'REST_TEMPLATE',
                        users: ['U503'],
                        sort: 700
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }
        
try {
            $response = $b24Service->core->call(
                'documentgenerator.template.update',
                [
                    'id' => 57,
                    'fields' => [
                        'name' => 'SUPPLY_CONTRACT_NEW Template',
                        'numeratorId' => 3,
                        'code' => 'REST_TEMPLATE',
                        'users' => ['U503'],
                        'sort' => 700,
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'documentgenerator.template.update',
            {
                id: 57,
                fields: {
                    name: 'SUPPLY_CONTRACT_NEW Template',
                    numeratorId: 3,
                    code: 'REST_TEMPLATE',
                    users: ['U503'],
                    sort: 700
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.template.update',
            [
                'id' => 57,
                'fields' => [
                    'name' => 'SUPPLY_CONTRACT_NEW Template',
                    'numeratorId' => 3,
                    'code' => 'REST_TEMPLATE',
                    'users' => ['U503'],
                    'sort' => 700,
                ],
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "template": {
                    "id": "57",
                    "name": "SUPPLY_CONTRACT_NEW Template",
                    "region": "ru",
                    "code": "REST_TEMPLATE",
                    "download": "https://mysite.ru/bitrix/services/main/ajax.php?action=documentgenerator.api.template.download&SITE_ID=s1&id=57&ts=0",
                    "active": "Y",
                    "moduleId": "rest",
                    "numeratorId": "3",
                    "withStamps": "N",
                    "providers": {
                        "bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
                    },
                    "users": {
                        "U503": "U503"
                    },
                    "isDeleted": "N",
                    "sort": "700",
                    "createTime": "2026-03-23T16:51:25+03:00",
                    "updateTime": "2026-03-23T17:26:39+03:00",
                    "downloadMachine": "https://mysite.ru/rest/documentgenerator.api.template.download.json?auth=6d53c1690000071b00000844000001f7f0f1075612a492ef6fe0b4127e521b543e4376&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3JnRzPTAmXz1UdDBpNDBOU2hvQkxtN1Y5VmhEZm1MbTU2ZmQ0d3puNA%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKblJ6UFRBbVh6MVVkREJwTkRCT1UyaHZRa3h0TjFZNVZtaEVabTFNYlRVMlptUTBkM3B1TkE9PXw2ZDUzYzE2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzU2MTJhNDkyZWY2ZmUwYjQxMjdlNTIxYjU0M2U0Mzc2Ig%3D%3D.6kAmDGdiQCSZI%2Bcm%2Fg86RUqVH5dMvSDxHbx20yjOYK4%3D"
                }
            },
            "time": {
                "start": 1774275999,
                "finish": 1774275999.631086,
                "duration": 0.6310861110687256,
                "processing": 0,
                "date_start": "2026-03-23T17:26:39+03:00",
                "date_finish": "2026-03-23T17:26:39+03:00",
                "operating_reset_at": 1774276599,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

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

time
time

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

Объект result

Название
тип

Описание

template
object

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

Объект template

Название
тип

Описание

id
string

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

name
string

Название шаблона

region
string

Регион шаблона

code
string

Символьный код шаблона

download
string

Ссылка на скачивание шаблона

downloadMachine
string

Ссылка на скачивание шаблона для машинной обработки

active
char

Активность шаблона. Возможные значения:

  • Y — активен
  • N — не активен

moduleId
string

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

numeratorId
string

Идентификатор нумератора

withStamps
char

Использование печатей и подписей. Возможные значения:

  • Y — да
  • N — нет

providers
object

Провайдеры данных шаблона.

Ключ и значение равны имени класса провайдера данных

users
object

Коды доступа к шаблону.

Ключ и значение равны коду доступа

isDeleted
char

Признак удаления шаблона. Возможные значения:

  • Y — удален
  • N — не удален

sort
string

Индекс сортировки

createTime
datetime

Дата и время создания

updateTime
datetime

Дата и время обновления

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Шаблон не найден"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

100

Bitrix\DocumentGenerator\Template constructor must be is public

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

400

100

Could not find value for parameter

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

400

0

Шаблон не найден

Шаблон с указанным id не найден

400

0

You do not have permissions to modify this template

Недостаточно прав на изменение указанного шаблона

400

0

You do not have permissions to modify templates

Недостаточно прав для изменения шаблонов

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

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

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

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

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

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

Предыдущая
Загрузить шаблон
Следующая
Получить шаблон по id