метод REST scope: documentgenerator

documentgenerator.template.add

Загрузить шаблон

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

Описание

Метод 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 -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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Empty required fields: numeratorId"
}
Код Описание Значение
400 100 Could not find value for parameter {fields}
400 100 Invalid value to match with parameter {fields}. Should be value of type array
400 0 Empty required fields: name, numeratorId, region
400 0 Missing file content
400 0 You do not have permissions to modify templates

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

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