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

Схема поля шаблона

GET /v1/requisite-presets/:presetId/fields/schema

Возвращает структуру строки поля шаблона реквизитов: типы, обязательность, флаги доступа. Используйте, чтобы узнать допустимые типы и правила перед POST /v1/requisite-presets/:presetId/fields или PATCH /v1/requisite-presets/:presetId/fields/:id.

Параметры

Параметр Тип Обяз. Описание
ПараметрpresetId (path) Типnumber Обяз.да ОписаниеID шаблона реквизитов. Получить список шаблонов: GET /v1/requisite-presets

Примеры

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/schema" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/schema" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

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

const { success, data } = await res.json()

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

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

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбъект с описанием схемы
Полеdata.fields Типobject ОписаниеСловарь полей строки шаблона. Ключи — в camelCase: id, fieldName и другие
Полеdata.fields.id Типobject ОписаниеИдентификатор строки поля. Только для чтения
Полеdata.fields.fieldName Типobject ОписаниеИмя поля реквизита, например RQ_INN. Обязательно при создании. При обновлении передавать не нужно — текущее значение подставляется автоматически
Полеdata.fields.fieldTitle Типobject ОписаниеЗаголовок поля в печатной форме. Не обязателен
Полеdata.fields.sort Типobject ОписаниеПорядок сортировки поля в шаблоне
Полеdata.fields.inShortList Типobject ОписаниеФлаг отображения поля в кратком списке. В API представлен как true/false

Каждое поле в data.fields описано объектом со следующими ключами:

Ключ Тип Описание
Ключtype Типstring ОписаниеТип значения: integer, string, boolean
КлючisRequired Типboolean ОписаниеОбязательно ли поле при создании
КлючisReadOnly Типboolean ОписаниеТолько для чтения — нельзя задать при записи
КлючisImmutable Типboolean ОписаниеНельзя изменить после создания
КлючisMultiple Типboolean ОписаниеДопускает несколько значений
КлючisDynamic Типboolean ОписаниеДинамическое (пользовательское) поле
Ключtitle Типstring ОписаниеНазвание поля для отображения, на языке портала

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": true,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "ID"
      },
      "fieldName": {
        "type": "string",
        "isRequired": true,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Имя"
      },
      "fieldTitle": {
        "type": "string",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Название в шаблоне"
      },
      "sort": {
        "type": "integer",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Сортировка"
      },
      "inShortList": {
        "type": "boolean",
        "isRequired": false,
        "isReadOnly": false,
        "isImmutable": false,
        "isMultiple": false,
        "isDynamic": false,
        "title": "Показывать в кратком списке"
      }
    }
  }
}

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

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

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PRESET_ID ОписаниеПереданный presetId не является положительным целым числом
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов

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

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

Поле inShortList и в схеме, и в данных булево. При записи через POST или PATCH передавайте true/false, в ответах чтения поле приходит как true/false. Битрикс24 в своём описании схемы называет тип этого поля char — Вайбкод приводит его к boolean, чтобы схема не расходилась со строками, которые она описывает.

Схема объявляет fieldName обязательным (isRequired: true), но при обновлении его передавать не нужно. При PATCH без fieldName Вайбкод получает текущее значение из Битрикс24 и подставляет его автоматически. Обязательным fieldName остаётся при создании через POST.

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