Изменить шаблон бизнес-процесса bizproc.workflow.template.update

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: bizproc

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

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

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

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

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

Название
тип

Описание

ID*
string

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

FIELDS*
object

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

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

Параметр FIELDS

Название
тип

Описание

NAME
string

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

DESCRIPTION
string

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

TEMPLATE_DATA
file

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

Подробнее о способах передачи файлов — в статье Как обновить и удалить файлы

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
        
try
        {
        	const response = await $b24.callMethod(
        		'bizproc.workflow.template.update',
        		{
        			ID: 525,
        			FIELDS: {
        				NAME: 'Вывести время',
        				DESCRIPTION: 'Шаблон показывает сообщение с локальным и серверным временем',
        				AUTO_EXECUTE: 0,
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	alert("Error: " + error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'bizproc.workflow.template.update',
                    [
                        'ID'     => 525,
                        'FIELDS' => [
                            'NAME'        => 'Вывести время',
                            'DESCRIPTION' => 'Шаблон показывает сообщение с локальным и серверным временем',
                            'AUTO_EXECUTE' => 0,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating workflow template: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'bizproc.workflow.template.update',
            {
                ID: 525,
                FIELDS: {
                    NAME: 'Вывести время',
                    DESCRIPTION: 'Шаблон показывает сообщение с локальным и серверным временем',
                    AUTO_EXECUTE: 0,
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.workflow.template.update',
            [
                'ID' => 525,
                'FIELDS' => [
                    'NAME' => 'Вывести время',
                    'DESCRIPTION' => 'Шаблон показывает сообщение с локальным и серверным временем',
                    'AUTO_EXECUTE' => 0
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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
object

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

time
time

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

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

HTTP-статус: 400

{
            "error": "ERROR_TEMPLATE_NOT_OWNER",
            "error_description": "You can update ONLY templates created by current application",
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Сообщение об ошибке

Описание

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!

Указаны неверные данные шаблона

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

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

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

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

Предыдущая
Добавить шаблон
Следующая
Получить список шаблонов