Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-templates/list.md индекс документации — /llms.txt
Список шаблонов
GET /v1/bizproc-templates
Возвращает шаблоны бизнес-процессов, заведённые на портале, с фильтрацией, сортировкой и пагинацией.
Параметры
| Параметр | Тип | По умолч. | Описание |
|---|---|---|---|
Параметрselect (query) |
Типstring | По умолч.— | ОписаниеПоля через запятую: id, moduleId, entity, documentType, autoExecute, name, description, modified, isModified, userId. Без select возвращается полный набор объявленных полей, включая id |
Параметрfilter (query) |
Типobject | По умолч.— | ОписаниеФильтрация по полям GET /v1/bizproc-templates/fields.Синтаксис фильтрации. Пример: ?filter[entity]=BizprocDocument.Значения moduleId и entity — первые два элемента documentType, они перечислены в Загрузить шаблон |
Параметрorder (query) |
Типobject | По умолч.— | ОписаниеСортировка. Пример: ?order[id]=desc |
Параметрlimit (query) |
Типnumber | По умолч.50 |
ОписаниеКоличество записей в ответе. Ноль не означает «без ограничения» — он игнорируется, приходят 50 записей и предупреждение LIMIT_ZERO_IGNORED |
Параметрoffset (query) |
Типnumber | По умолч.0 |
ОписаниеСмещение выборки |
ПараметрwithTotal (query) |
Типboolean | По умолч.— | ОписаниеПринимается, но на ответ не влияет: meta.total приходит при любом значении |
Для limit больше 50 запрос пагинируется на стороне сервера. Максимум — 5000 записей за вызов.
Примеры
Токен сессии для примеров с ключом OAuth-приложения выдаёт OAuth-авторизация, он живёт 24 часа без продления — Передача ключа.
curl — личный ключ
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-templates?select=id,name,moduleId,entity,autoExecute&limit=2" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-templates?select=id,name,moduleId,entity,autoExecute&limit=2" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const params = new URLSearchParams({
select: 'id,name,moduleId,entity,autoExecute',
limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/bizproc-templates?${params}`, {
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
})
const { success, data, meta } = await res.json()
console.log(`Шаблонов на портале: ${meta.total}`)
JavaScript — OAuth-приложение
const params = new URLSearchParams({
select: 'id,name,moduleId,entity,autoExecute',
limit: '2',
})
const res = await fetch(`https://vibecode.bitrix24.tech/v1/bizproc-templates?${params}`, {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { success, data, meta } = await res.json()
console.log(`Шаблонов на портале: ${meta.total}`)
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типarray | ОписаниеМассив шаблонов. Состав полей элемента определяется параметром select, полная схема — Поля шаблона |
Полеmeta.total |
Типnumber | ОписаниеКоличество шаблонов, попавших под фильтр |
Полеmeta.hasMore |
Типboolean | ОписаниеЕсть ли записи за пределами limit |
Полеmeta.warnings |
Типarray | ОписаниеПредупреждения о разборе запроса. Каждое — объект с полями code, field и message, например неизвестное имя поля в select с кодом UNKNOWN_SELECT_FIELD |
Пример ответа
{
"success": true,
"data": [
{
"id": 23,
"name": "Согласование договора",
"moduleId": "lists",
"entity": "BizprocDocument",
"autoExecute": 1
},
{
"id": 25,
"name": "Заявка на закупку",
"moduleId": "lists",
"entity": "BizprocDocument",
"autoExecute": 1
}
],
"meta": {
"total": 81,
"hasMore": true
}
}
Пример ответа при ошибке
403 — ключу не хватает скоупа bizproc:
{
"success": false,
"error": {
"code": "SCOPE_DENIED",
"message": "This endpoint requires 'bizproc' scope"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_FILTER_OPERATOR |
ОписаниеНеизвестный оператор в фильтре. Сообщение перечисляет поддерживаемые операторы |
| HTTP400 | КодINVALID_FILTER_OPERATOR |
ОписаниеЛогический ключ $or или $and в фильтре. Условие ИЛИ задаётся оператором $in для одного поля или параллельными запросами через POST /v1/batch, условие И — соседними ключами одного фильтра |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеКлюч OAuth-приложения без заголовка Authorization: Bearer |
| HTTP401 | КодWRONG_AUTH_SCHEME |
ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии |
| HTTP401 | КодINVALID_SESSION |
ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа bizproc |
| HTTP409 | КодBIZPROC_MODULE_NOT_ENABLED |
ОписаниеБизнес-процессов на портале нет: модуль не входит в тариф либо выключен в настройках портала. Попросите администратора портала включить бизнес-процессы — до этого метод отвечает так же при любом числе повторов |
| HTTP429 | КодRATE_LIMITED |
ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After |
Полный список общих ошибок API — Ошибки.
Известные особенности
Файл шаблона в ответе не приходит. Содержимое .bpt, переданное при создании в поле templateData, обратно через API не читается — ни в списке, ни через select. Сохраняйте исходный файл на своей стороне.
Поле documentType собирается из moduleId и entity. Запрашивайте все три поля вместе — иначе первые два элемента массива приходят как null: select=id,documentType вернёт [null, null, "iblock_19"], а select=id,documentType,moduleId,entity — ["lists", "BizprocDocument", "iblock_19"].
Неизвестное имя поля в select, filter или order не вызывает ошибку. Ответ приходит с кодом 200, неизвестное имя отбрасывается: в filter выборка не сужается, в order порядок не меняется, в select поле отсутствует в записях, а в meta.warnings приходит предупреждение с кодом UNKNOWN_SELECT_FIELD. Имена полей сверяйте со строкой select в таблице параметров или со схемой GET /v1/bizproc-templates/fields.