метод REST scope: bizproc

bizproc.workflow.template.update

Изменить шаблон бизнес-процесса

Кто может выполнять: администратор

Описание

Метод обновляет шаблон бизнес-процесса.

С его помощью можно обновить шаблоны, которые были созданы методом bizproc.workflow.template.add. Эти шаблоны привязаны к приложению и могут быть обновлены только в контексте того же приложения, которым они были созданы.

Параметры

ID string обязательный

Идентификатор шаблона, который нужно обновить

FIELDS object обязательный

Объект с полями шаблона бизнес-процесса.

Обновить можно поля: NAME, DESCRIPTION, TEMPLATE_DATA, AUTO_EXECUTE. При попытке обновить другие поля шаблона, ошибок не возникнет, но эти поля обновлены не будут

Параметр FIELDS

NAME string необязательный

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

DESCRIPTION string необязательный

Описание шаблона

TEMPLATE_DATA file необязательный

Контент файла с шаблоном бизнес-процесса в формате .bpt.

Подробнее о способах передачи файлов — в статье How to update files

AUTO_EXECUTE integer необязательный

Настройки автозапуска шаблона. Может иметь значение:

  • 0 — без автозапуска
  • 1 — запуск на создание
  • 2 — запуск на изменение
  • 3 — запуск на создание и изменение

По умолчанию — 0

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ID":525,"FIELDS":{"NAME":"Вывести время","DESCRIPTION":"Шаблон показывает сообщение с локальным и серверным временем","AUTO_EXECUTE":0},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.workflow.template.update

Ответ

HTTP-статус: 200

{
    "result": 525,
    "time": {
        "start": 1737534421.172673,
        "finish": 1737534421.209758,
        "duration": 0.037085056304931641,
        "processing": 0.010869026184082031,
        "date_start": "2025-01-22T11:27:01+03:00",
        "date_finish": "2025-01-22T11:27:01+03:00",
        "operating_reset_at": 1737535021,
        "operating": 0
    }
}

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

result integer

Идентификатор обновленного шаблона бизнес-процесса

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_TEMPLATE_NOT_OWNER",
    "error_description": "You can update ONLY templates created by current application"
}
Код Описание Значение
ACCESS_DENIED Application context required Токен доступа не из приложения
ACCESS_DENIED Access denied! Метод запустил не администратор
ERROR_TEMPLATE_VALIDATION_FAILURE No fields to update. Не указаны поля для обновления
ERROR_TEMPLATE_NOT_FOUND Workflow template not found. Не найден шаблон с заданным ID
ERROR_TEMPLATE_NOT_OWNER You can update ONLY templates created by current application Данный шаблон нельзя редактировать через это приложение
ERROR_TEMPLATE_VALIDATION_FAILURE Empty template name! Указано пустое название шаблона
ERROR_TEMPLATE_VALIDATION_FAILURE Incorrect field AUTO_EXECUTE! Указан неверный код автозапуска
ERROR_TEMPLATE_VALIDATION_FAILURE Incorrect field TEMPLATE_DATA! Указаны неверные данные шаблона

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

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