Работа с бизнес-шаблонами
Добавление нового шаблона
POST v2/workflow/templates/upsert
Метод принимает 5 параметров:
name - системное имя шаблона;
displayName - отображаемое имя шаблона;
version - версия шаблона;
description - описание шаблона;
file - сам шаблон.
Параметры name, displayName, version, file являются обязательными к заполнению.
Этот метод позволяет изменять уже созданные шаблоны.
Удаление шаблонов
DELETE v2/workflow/templates/delete
Пример запроса:
{
"name": "string", // системное имя шаблона
"storageId": "string", // storageId (устанавливается всегда по умолчанию в значение 'default'. Если не передавать этот параметр, то удаление по умолчанию будет происходить с текущим значением)
"version": "string" // версия шаблона
}
Получение шаблонов
POST v2/workflow/templates/list
Запрос позволяет фильтровать системные и отображаемые имена по полям. Также есть возможность сортировки по дате загрузки, системному и отображаемому именам.
Пример запроса:
{
"name": "string", // системное имя шаблона (при указании будут возвращены шаблоны с указанным именем)
"displayName": "string", // отображаемое имя шаблона (при указании будут возвращены шаблоны с указанным отображаемым именем)
"sortFields": [ // поля сортировки
{
"name": "name", // поле, по которому происходит сортировка (ожидается name/display_name/create_date)
"order": "string" // порядок сортировки - ASC/DESC
}
]
}
Ответ успешного выполнения запроса:
{
"templates": [
{
"storageId": "string", // storageId (по умолчанию для всех шаблонов 'default')
"name": "string", // системное имя шаблона
"displayName": "string", // отображаемое имя шаблона
"description": "string", // описание шаблона
"version": "string", // версия шаблона
"editable": true, // доступен ли шаблон для редактирования
"createdBy": "string", // автор шаблона
"createDate": "2024-12-25T09:24:35.002Z" // дата создания шаблона
}
]
}