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

Поля робота

GET /v1/bizproc-robots/fields

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

Примеры

Читать схему можно только ключом авторизации — оба примера отправляют ключ авторизации и заголовок Authorization: Bearer. Токен сессии выдаёт OAuth-авторизация и живёт 24 часа без продления — Передача ключа.

curl — ключ авторизации

Terminal 
curl -X GET "https://vibecode.bitrix24.tech/v1/bizproc-robots/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-robots/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 Тип значения: string, number, object, array
data.fields.<поле>.readonly boolean true — поле заполняется системой и в запросах на запись не передаётся
data.fields.<поле>.required boolean Приходит только у обязательных на регистрацию полей
data.fields.<поле>.label string Короткая подпись поля
data.fields.<поле>.description string Развёрнутое описание поля
data.batch array Операции сущности, доступные в POST /v1/batch

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

Поле Тип RO Обяз. Описание
code string да Уникальный код робота. Служит идентификатором в путях обновления и удаления
handler string да URL обработчика робота
name string да Название робота
description string нет Описание робота
authUserId number нет Пользователь, чей токен передаётся приложению при вызове. Список: GET /v1/users
useSubscription string нет Ждать ли ответа приложения перед продолжением процесса: Y или N
properties object нет Входные параметры робота
returnProperties object нет Выходные параметры робота
documentType array нет Тип документа, к которому применим робот — массив из трёх элементов: модуль, объект, тип. Допустимые сочетания: Зарегистрировать робота
filter object нет Правила INCLUDE и EXCLUDE по типу документа
usePlacement string нет Открывать настройки робота в выдвижной панели: Y или N
placementHandler string нет URL выдвижной панели настроек

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "code": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Код",
        "description": "Уникальный код робота. Служит идентификатором в путях обновления и удаления."
      },
      "handler": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "URL обработчика",
        "description": "URL обработчика робота."
      },
      "name": {
        "type": "string",
        "readonly": false,
        "required": true,
        "label": "Название",
        "description": "Название робота."
      },
      "description": {
        "type": "string",
        "readonly": false,
        "label": "Описание",
        "description": "Описание робота."
      },
      "authUserId": {
        "type": "number",
        "readonly": false,
        "label": "ID пользователя-авторизатора",
        "description": "Пользователь, чей токен передаётся приложению при вызове. Список: GET /v1/users."
      },
      "useSubscription": {
        "type": "string",
        "readonly": false,
        "label": "Ожидание ответа",
        "description": "Ждать ли ответа приложения перед продолжением процесса: Y или N."
      },
      "properties": {
        "type": "object",
        "readonly": false,
        "label": "Входные параметры",
        "description": "Входные параметры робота."
      },
      "returnProperties": {
        "type": "object",
        "readonly": false,
        "label": "Выходные параметры",
        "description": "Выходные параметры робота."
      },
      "documentType": {
        "type": "array",
        "readonly": false,
        "label": "Тип документа",
        "description": "Тип документа, к которому применим робот."
      },
      "filter": {
        "type": "object",
        "readonly": false,
        "label": "Фильтр по типу документа",
        "description": "Правила INCLUDE и EXCLUDE по типу документа."
      },
      "usePlacement": {
        "type": "string",
        "readonly": false,
        "label": "Настройки в панели",
        "description": "Открывать настройки робота в выдвижной панели: Y или N."
      },
      "placementHandler": {
        "type": "string",
        "readonly": false,
        "label": "URL панели настроек",
        "description": "URL выдвижной панели настроек."
      }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

403 — запрос отправлен API-ключом:

JSON 
{
  "success": false,
  "error": {
    "code": "OAUTH_REQUIRED",
    "message": "bizproc-robots require an OAuth app key (vibe_app_*) with an Authorization: Bearer session — a personal vibe_api_* key lacks the per-user OAuth context Bitrix24 needs for these methods. Create an OAuth app (POST /v1/apps) and retry with its key. On this 403 switch keys — do NOT delete or recreate the app (that discards anything already registered under it, e.g. a bizproc robot you just registered)."
  }
}

Ошибки

HTTP Код Описание
403 OAUTH_REQUIRED Запрос отправлен API-ключом. Схема доступна только ключу авторизации
401 TOKEN_MISSING Ключ авторизации без заголовка Authorization: Bearer
401 WRONG_AUTH_SCHEME Ключ авторизации отправлен в заголовке Authorization: Bearer. Сам ключ передаётся в X-Api-Key, а Authorization: Bearer несёт токен сессии
401 INVALID_SESSION Токен сессии истёк или недействителен — пройдите авторизацию заново
403 SCOPE_DENIED Ключу не хватает скоупа bizproc

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

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

Схема одинакова у роботов и действий. Обе сущности описываются одним набором из двенадцати полей — различается смысл, а не состав.

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