# Шаблоны бизнес-процессов

Шаблон бизнес-процесса — заготовка процесса, привязанная к типу документа: сделке, лиду, элементу списка, документу Диска. По шаблону Битрикс24 запускает процесс, когда документ создаётся или меняется. Приложение загружает готовый шаблон файлом `.bpt`, меняет его настройки и удаляет.

Битрикс24 API: `bizproc.workflow.template.*`
Скоуп: `bizproc`

## Операции

- [Загрузить шаблон](./bizproc-templates/create.md) — `POST /v1/bizproc-templates`
- [Список шаблонов](./bizproc-templates/list.md) — `GET /v1/bizproc-templates`
- [Обновить шаблон](./bizproc-templates/update.md) — `PATCH /v1/bizproc-templates/:id`
- [Удалить шаблон](./bizproc-templates/delete.md) — `DELETE /v1/bizproc-templates/:id`
- [Поиск шаблонов](./bizproc-templates/search.md) — `POST /v1/bizproc-templates/search`
- [Поля шаблона](./bizproc-templates/fields.md) — `GET /v1/bizproc-templates/fields`

## Ключевые поля

| Поле | Тип | Описание |
|------|-----|---------|
| `id` | number | Идентификатор шаблона. Указывается в путях обновления и удаления |
| `name` | string | Название шаблона |
| `documentType` | array | Тип документа из трёх элементов — модуль, объект, тип. Задаётся при загрузке, допустимые значения — [Загрузить шаблон](./bizproc-templates/create.md) |
| `templateData` | array | Файл шаблона — имя файла и содержимое в base64. Передаётся при загрузке и обновлении, в ответах не возвращается |
| `autoExecute` | number | Условие автозапуска: `0` — без автозапуска, `1` — при создании документа, `2` — при изменении, `3` — при создании и изменении |
| `isModified` | boolean | Правился ли шаблон после загрузки файла |
| `userId` | number | Автор последнего изменения. Список: [`GET /v1/users`](/docs/entities/users) |

## Что нужно знать перед работой

1. **Нужен ключ авторизации `vibe_app_…`, не API-ключ `vibe_api_…`.** Все шесть операций требуют контекст приложения. API-ключ вернёт `403 OAUTH_REQUIRED`. Ключ авторизации отправляется вместе с заголовком `Authorization: Bearer` — см. [Ключи и авторизация](/docs/keys-auth). Токен сессии выдаёт OAuth-авторизация, живёт 24 часа и не продлевается — после истечения вызовы возвращают `401 INVALID_SESSION` и нужна повторная авторизация. Как получить и передать токен — [Передача ключа](/docs/keys-auth#передача-ключа).
2. **Только администратор.** Управлять шаблонами может пользователь с правами администратора портала. У остальных запрос завершается ошибкой доступа.
3. **Приложение распоряжается только своими шаблонами.** Обновить и удалить можно шаблон, загруженный тем же приложением. Шаблоны из конструктора Битрикс24 и других приложений видны в списке, но на изменение возвращают `422`.
4. **Шаблон загружается файлом.** Процесс настраивается в конструкторе бизнес-процессов Битрикс24 и выгружается в файл `.bpt`, содержимое которого передаётся в `templateData` в base64. Собрать шаблон из полей через API нельзя.
5. **Без `select` список возвращает все объявленные поля, включая `id`.** Параметр нужен, только чтобы сузить ответ до конкретных полей.
6. **Получения одного шаблона нет.** Операция `get` недоступна — читайте запись через список с фильтром по `id`.

## Связанные сущности

| Сущность | Эндпоинт | Назначение |
|----------|----------|-----------|
| Действия бизнес-процессов | [`/v1/bizproc-activities`](/docs/entities/bizproc-activities) | Собственные действия приложения в дизайнере процессов |
| Роботы | [`/v1/bizproc-robots`](/docs/entities/bizproc-robots) | Роботы автоматизации в конструкторе правил |
| Бизнес-процессы | [`/v1/workflows`](/docs/automation/workflows) | Запуск процесса по шаблону, список запущенных, завершение |
| Смарт-процессы | [`/v1/smart-processes`](/docs/entities/smart-processes) | Источник `entityTypeId` для типа документа смарт-процесса |

## Типичный сценарий

1. Настройте процесс в конструкторе бизнес-процессов Битрикс24 и выгрузите его в файл `.bpt`.
2. Загрузите файл через [`POST /v1/bizproc-templates`](./bizproc-templates/create.md), указав тип документа и условие автозапуска. В ответе придёт `id`.
3. Проверьте запись через [`GET /v1/bizproc-templates`](./bizproc-templates/list.md) с фильтром по `id` и нужным `select`.
4. Меняйте название, описание, условие автозапуска или сам файл через [`PATCH /v1/bizproc-templates/:id`](./bizproc-templates/update.md).
5. Ненужный шаблон удалите через [`DELETE /v1/bizproc-templates/:id`](./bizproc-templates/delete.md).

## Лимиты

| Лимит | Значение |
|-------|----------|
| Максимум записей на запрос | 5000 |
| Автоматическая пагинация | включается при `limit` больше 50 |
| Batch-запросы | до 50 операций в [`POST /v1/batch`](/docs/batch) |
| Частота запросов | общий лимит API Вайбкод — см. [Лимиты и оптимизация](/docs/optimization) |

## Смотрите также

- [Действия бизнес-процессов](/docs/entities/bizproc-activities)
- [Роботы](/docs/entities/bizproc-robots)
- [Бизнес-процессы](/docs/automation/workflows)
- [Ключи и авторизация](/docs/keys-auth)
- [Справочник API](/docs/api-reference)