Загрузить шаблон documentgenerator.template.add

Scope: documentgenerator

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

Метод documentgenerator.template.add добавляет новый шаблон документа.

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

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

Название `тип`	Описание
fields* `object`	Набор полей шаблона (подробное описание)

Параметр fields

Название `тип`	Описание
name* `string`	Название шаблона
fileId* `integer`	Идентификатор ранее загруженного файла шаблона с Диска. Получить идентификатор файла можно двумя способами. Использовать один из методов загрузки файла: disk.storage.uploadfile disk.folder.uploadfile Использовать один из методов получения списка файлов: disk.storage.getchildren disk.folder.getchildren
file* `file`	Файл шаблона, если его нужно загрузить. Используется вместо параметра `fileId`. Файл можно передать тремя способами: строкой 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` — все члены рабочей группы или проекта Если не передан, автоматически добавляется текущий пользователь
active `char`	Активность шаблона. Возможные значения: `Y` — активен `N` — не активен По умолчанию `Y`
withStamps `char`	Подставлять печати и подписи. Возможные значения: `Y` — да `N` — нет По умолчанию `N`
sort `integer`	Индекс сортировки

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"name":"SUPPLY_CONTRACT Template","fileId":5641,"numeratorId":1,"region":"ru","code":"REST_TEMPLATE","users":["UA"],"active":"Y","withStamps":"N","sort":500}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/documentgenerator.template.add

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"name":"SUPPLY_CONTRACT Template","fileId":5641,"numeratorId":1,"region":"ru","code":"REST_TEMPLATE","users":["UA"],"active":"Y","withStamps":"N","sort":500},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/documentgenerator.template.add

try
        {
            const response = await $b24.callMethod(
                'documentgenerator.template.add',
                {
                    fields: {
                        name: 'SUPPLY_CONTRACT Template',
                        fileId: 5641,
                        numeratorId: 1,
                        region: 'ru',
                        code: 'REST_TEMPLATE',
                        users: ['UA'],
                        active: 'Y',
                        withStamps: 'N',
                        sort: 500
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service->core->call(
                'documentgenerator.template.add',
                [
                    'fields' => [
                        'name' => 'SUPPLY_CONTRACT Template',
                        'fileId' => 5641,
                        'numeratorId' => 1,
                        'region' => 'ru',
                        'code' => 'REST_TEMPLATE',
                        'users' => ['UA'],
                        'active' => 'Y',
                        'withStamps' => 'N',
                        'sort' => 500,
                    ],
                ]
            );
        
            $result = $response->getResponseData()->getResult();
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'documentgenerator.template.add',
            {
                fields: {
                    name: 'SUPPLY_CONTRACT Template',
                    fileId: 5641,
                    numeratorId: 1,
                    region: 'ru',
                    code: 'REST_TEMPLATE',
                    users: ['UA'],
                    active: 'Y',
                    withStamps: 'N',
                    sort: 500
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'documentgenerator.template.add',
            [
                'fields' => [
                    'name' => 'SUPPLY_CONTRACT Template',
                    'fileId' => 5641,
                    'numeratorId' => 1,
                    'region' => 'ru',
                    'code' => 'REST_TEMPLATE',
                    'users' => ['UA'],
                    'active' => 'Y',
                    'withStamps' => 'N',
                    'sort' => 500,
                ],
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "template": {
                    "id": "57",
                    "name": "SUPPLY_CONTRACT 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": "1",
                    "withStamps": "N",
                    "providers": {
                        "bitrix\\documentgenerator\\dataprovider\\rest": "bitrix\\documentgenerator\\dataprovider\\rest"
                    },
                    "users": {
                        "UA": "UA"
                    },
                    "isDeleted": "N",
                    "sort": "500",
                    "createTime": "2026-03-23T16:51:25+03:00",
                    "updateTime": "2026-03-23T16:51:25+03:00",
                    "downloadMachine": "https://mysite.ru/rest/documentgenerator.api.template.download.json?auth=6d53c1690000071b00000844000001f7f0f1075612a492ef6fe0b4127e521b543e4376&token=documentgenerator%7CYWN0aW9uPWRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZCZTSVRFX0lEPXMxJmlkPTU3JnRzPTAmXz1IeG56TmtsQklGNjRsQlBkNkNiekNwd1U2bnduQk40Mw%3D%3D%7CImRvY3VtZW50Z2VuZXJhdG9yLmFwaS50ZW1wbGF0ZS5kb3dubG9hZHxkb2N1bWVudGdlbmVyYXRvcnxZV04wYVc5dVBXUnZZM1Z0Wlc1MFoyVnVaWEpoZEc5eUxtRndhUzUwWlcxd2JHRjBaUzVrYjNkdWJHOWhaQ1pUU1ZSRlgwbEVQWE14Sm1sa1BUVTNKblJ6UFRBbVh6MUllRzU2VG10c1FrbEdOalJzUWxCa05rTmlla053ZDFVMmJuZHVRazQwTXc9PXw2ZDUzYzE2OTAwMDAwNzFiMDAwMDA4NDQwMDAwMDFmN2YwZjEwNzU2MTJhNDkyZWY2ZmUwYjQxMjdlNTIxYjU0M2U0Mzc2Ig%3D%3D.vtTu%2B9Ac%2BT5VgeyDm1jiVBGsmCQagvrqjACd%2BNgDigA%3D"
                }
            },
            "time": {
                "start": 1774273885,
                "finish": 1774273885.843453,
                "duration": 0.8434529304504395,
                "processing": 0,
                "date_start": "2026-03-23T16:51:25+03:00",
                "date_finish": "2026-03-23T16:51:25+03:00",
                "operating_reset_at": 1774274485,
                "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": "Empty required fields: numeratorId"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`100`	Could not find value for parameter	Не передан обязательный параметр `fields`
`400`	`100`	Invalid value to match with parameter {fields}. Should be value of type array	Параметр `fields` передан не как объект
`400`	`0`	Empty required fields: name, numeratorId, region	Не переданы обязательные поля для создания шаблона: `name`, `numeratorId`, `region`. В ошибке перечислены те поля, которых не хватает в запросе
`400`	`0`	Missing file content	Не передан файл шаблона
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Обзор методов

Изменить шаблон

Загрузить шаблон documentgenerator.template.add

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

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

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

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

Объект resultОбъект result

Объект templateОбъект template

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

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

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

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