метод REST scope: documentgenerator

documentgenerator.template.update

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

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

Описание

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

Ответ

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

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Шаблон не найден"
}
Код Описание Значение
400 100 Bitrix\DocumentGenerator\Template constructor must be is public
400 100 Could not find value for parameter {fields}
400 0 Шаблон не найден
400 0 You do not have permissions to modify this template
400 0 You do not have permissions to modify templates

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

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