метод REST scope: bizproc

bizproc.workflow.template.list

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

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

Описание

Метод получает список шаблонов бизнес-процессов, которые созданы в дизайнере.

Шаблоны роботов, настроенных на стадиях элементов CRM, смарт-процессов или в задачах, метод не возвращает. Такие шаблоны недоступны в REST API.

Параметры

SELECT array необязательный

Массив содержит список полей, которые необходимо выбрать.

Можно указать только те поля, которые необходимы.

Значение по умолчанию — ['ID']

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

Объект для фильтрации списка шаблонов бизнес-процессов в формате {"field_1": "value_1", ... "field_N": "value_N"}, где
- field_Nполе шаблона для фильтра
- value_N — значение поля

Перед названием фильтруемого поля можно указать тип фильтрации:
- = — равно
- ! или != — не равно
- < — меньше
- <= — меньше либо равно
- > — больше
- >= — больше либо равно

Без префикса фильтр сравнивает значение на равенство. Название поля можно передавать в любом регистре

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

Объект для сортировки списка запущенных бизнес-процессов в формате {"field_1": "value_1", ... "field_N": "value_N"}, где
- field_Nполе шаблона для сортировки
- value_N — направление сортировки

Направление сортировки может принимать значения:
- asc — по возрастанию
- desc — по убыванию

Можно указать несколько полей для сортировки, например, {NAME: 'ASC', ID: 'DESC'}.

Значение по умолчанию — {ID: 'ASC'}

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

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 50, где N — номер нужной страницы

Поля шаблона

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

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

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

Идентификатор модуля по документу. Возможные значения:
- crm — CRM
- lists — универсальные списки
- disk — диск

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

Идентификатор объекта по документу. Возможные значения:

CRM
- CCrmDocumentLead — лиды
- CCrmDocumentContact — контакты
- CCrmDocumentCompany — компании
- CCrmDocumentDeal — сделки
- Bitrix\Crm\Integration\BizProc\Document\Quote — коммерческие предложения
- Bitrix\Crm\Integration\BizProc\Document\SmartInvoice — счета
- Bitrix\Crm\Integration\BizProc\Document\Dynamic — смарт-процессы

Списки
- BizprocDocument — процессы в ленте новостей
- Bitrix\Lists\BizprocDocumentLists — списки в группах

Диск
- Bitrix\Disk\BizProcDocument

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

Тип документа. Возможные значения:
crm:
- LEAD — лиды
- CONTACT — контакты
- COMPANY — компании
- DEAL — сделки
- QUOTE — коммерческие предложения
- SMART_INVOICE — счета
- DYNAMIC_XXX — смарт-процессы, где XXX — идентификатор смарт-процесса

списки:
- iblock_XXX — информационный блок, где XXX — идентификатор информационного блока

диск:
- STORAGE_XXX — хранилище диска, где XXX — идентификатор хранилища

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

Флаг автозапуска. Может принимать значения:

  • 0 — без автозапуска
  • 1 — запуск на создание
  • 2 — запуск на изменение
  • 3 — запуск на создание и изменение
NAME string необязательный

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

TEMPLATE array необязательный

Массив с описанием структуры действий шаблона

PARAMETERS array необязательный

Параметры шаблона

VARIABLES array необязательный

Переменные шаблона

CONSTANTS array необязательный

Константы шаблона

MODIFIED datetime необязательный

Дата последнего изменения

IS_MODIFIED boolean необязательный

Был ли изменен шаблон. Возможные значения:
- Y — да, был изменен
- N — нет

Опция нужна для типовых шаблонов бизнес-процессов

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

Идентификатор пользователя, который создал или изменил шаблон

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

Системный код шаблона.

Нужен для идентификации шаблонов типовых бизнес-процессов или шаблонов, созданных приложением

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["ID","NAME","USER_ID","SYSTEM_CODE"],"filter":{"MODULE_ID":"lists","AUTO_EXECUTE":0},"order":{"ID":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.workflow.template.list

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "ID": "525",
            "NAME": "Вывести время",
            "USER_ID": "503",
            "SYSTEM_CODE": "rest_app_5"
        },
        {
           "ID": "379",
           "NAME": "App template",
           "USER_ID": "503",
           "SYSTEM_CODE": "rest_app_5"
        }
    ],
    "total": 34,
    "time": {
        "start": 1737535822.539526,
        "finish": 1737535822.564579,
        "duration": 0.025053024291992188,
        "processing": 0.0019738674163818359,
        "date_start": "2025-01-22T11:50:22+03:00",
        "date_finish": "2025-01-22T11:50:22+03:00",
        "operating_reset_at": 1737536422,
        "operating": 0
    }
}

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

result array

Корневой элемент ответа.

Содержит массив объектов с информацией о шаблонах бизнес-процессов.

Каждый объект содержит поля шаблона, указанные в параметре SELECT

total integer

Общее количество найденных записей

time time

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

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

HTTP-статус: 400

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}
Код Описание Значение
ACCESS_DENIED Access denied! Метод запустил не администратор

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

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