Для AI-агентов: markdown этой страницы — /docs-content/entities/bizproc-templates/fields.md индекс документации — /llms.txt

Поля шаблона

GET /v1/bizproc-templates/fields

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

Примеры

Токен сессии для примеров с ключом OAuth-приложения выдаёт OAuth-авторизация, он живёт 24 часа без продления — Передача ключа.

curl — личный ключ

Terminal
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-templates/fields" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-templates/fields" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-templates/fields', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
console.log(Object.keys(data.fields))

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/bizproc-templates/fields', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
console.log(Object.keys(data.fields))

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.fields Типobject ОписаниеСхема полей: ключ — имя поля, значение — его описание
Полеdata.fields.<поле>.type Типstring ОписаниеТип значения: number, string, array, datetime, boolean
Полеdata.fields.<поле>.readonly Типboolean Описаниеtrue — поле заполняется системой и в запросах на запись не передаётся
Полеdata.fields.<поле>.writeOnly Типboolean Описаниеtrue — поле принимается на запись, но не возвращается в ответах
Полеdata.fields.<поле>.notReturned Типboolean Описаниеtrue — имя поля отсутствует во всех ответах чтения и не поддерживается в select
Полеdata.fields.<поле>.required Типboolean ОписаниеПриходит только у обязательных на создание полей
Полеdata.batch Типarray ОписаниеОперации сущности, доступные в POST /v1/batch

Состав схемы:

Поле Тип RO Описание
Полеid Типnumber RORO ОписаниеИдентификатор шаблона
ПолеmoduleId Типstring RO ОписаниеМодуль, к которому привязан шаблон: lists, crm, disk, bizproc
Полеentity Типstring RO ОписаниеОбъект документа внутри модуля, например BizprocDocument
ПолеdocumentType Типarray RO ОписаниеТип документа из трёх элементов — модуль, объект, тип
ПолеtemplateData Типarray RO ОписаниеФайл шаблона — имя файла и содержимое в base64. Обязателен на создание, в ответах чтения не возвращается
ПолеautoExecute Типnumber RO ОписаниеУсловие автозапуска: 0 — без автозапуска, 1 — при создании документа, 2 — при изменении, 3 — при создании и изменении
Полеname Типstring RO ОписаниеНазвание шаблона
Полеdescription Типstring RO ОписаниеОписание шаблона
Полеmodified Типdatetime RORO ОписаниеДата последнего изменения
ПолеisModified Типboolean RORO ОписаниеПравился ли шаблон после загрузки файла
ПолеuserId Типnumber RO ОписаниеАвтор последнего изменения. Список: GET /v1/users

Пример ответа

JSON
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "moduleId": { "type": "string", "readonly": false },
      "entity": { "type": "string", "readonly": false },
      "documentType": { "type": "array", "readonly": false },
      "templateData": { "type": "array", "readonly": false, "writeOnly": true, "notReturned": true, "required": true },
      "autoExecute": { "type": "number", "readonly": false },
      "name": { "type": "string", "readonly": false },
      "description": { "type": "string", "readonly": false },
      "modified": { "type": "datetime", "readonly": true },
      "isModified": { "type": "boolean", "readonly": true },
      "userId": { "type": "number", "readonly": false }
    },
    "batch": ["create", "update", "delete"]
  }
}

Пример ответа при ошибке

403 — ключу не хватает скоупа bizproc:

JSON
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'bizproc' scope"
  }
}

Ошибки

HTTP Код Описание
HTTP401 КодTOKEN_MISSING ОписаниеКлюч OAuth-приложения без заголовка Authorization: Bearer
HTTP401 КодWRONG_AUTH_SCHEME ОписаниеКлюч авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии
HTTP401 КодINVALID_SESSION ОписаниеТокен сессии истёк или недействителен — пройдите авторизацию заново
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа bizproc
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

Полный список общих ошибок API — Ошибки.

Известные особенности

Метка readonly: false не означает, что поле можно изменить. Обновление применяет только name, description, autoExecute и templateData — см. Обновить шаблон. Остальные поля без метки readonly — moduleId, entity, documentType, userId — задаются при загрузке файла, и запрос на их изменение вернёт 200 без эффекта.

Отсутствие метки readonly не означает, что поле можно прочитать. У templateData стоит readonly: false, но обратно это поле не приходит ни в списке, ни через select — оно доступно только на запись.

Метка required: true стоит только у templateData, хотя при загрузке обязательны три поля. Схема отражает проверку на стороне Вайбкод: без templateData запрос отклоняется сразу с кодом MISSING_REQUIRED_FIELDS. Отсутствие name или documentType проходит эту проверку и отклоняется на шаг позже, с кодом BITRIX_ERROR. Полный список обязательных полей загрузки — на странице Загрузить шаблон.

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