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

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной 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 (OAuth)

Python

PHP

BX24.js

PHP CRest

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);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.workflow.template.update(
        bitrix_id=525,
        fields={
            "NAME": "Вывести время",
            "DESCRIPTION": "Шаблон показывает сообщение с локальным и серверным временем",
            "AUTO_EXECUTE": 0,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {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>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.workflow.template.update", b24.Params{
	"ID": 525,
	"FIELDS": b24.Params{
		"NAME":         "Вывести время",
		"DESCRIPTION":  "Шаблон показывает сообщение с локальным и серверным временем",
		"AUTO_EXECUTE": 0,
	},
})
if err != nil {
	return fmt.Errorf("bizproc.workflow.template.update: %w", err)
}

var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("результат:", value)

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

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"
}

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

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

Код	Сообщение об ошибке	Описание
`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-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Была ли статья полезна?

Добавить шаблон

Получить список шаблонов

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

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

Параметр FIELDSПараметр FIELDS

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

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

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

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

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

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

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