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

Поля, доступные для добавления

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

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

Параметры

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

Примеры

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

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

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

Terminal 
curl "https://vibecode.bitrix24.tech/v1/requisite-presets/1/fields/available" \
  -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/available', {
  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/available', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типunknown ОписаниеИсходный result метода Битрикс24 crm.requisite.preset.field.availabletoadd, без преобразования структуры и ключей. Если result отсутствует или равен null, возвращается []

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

Ниже показан пример результата в виде массива строк. Маршрут не гарантирует эту форму: структура ответа определяется результатом Битрикс24.

JSON 
{
  "success": true,
  "data": [
    "RQ_NAME",
    "RQ_FIRST_NAME",
    "RQ_LAST_NAME",
    "RQ_SECOND_NAME",
    "RQ_CONTACT",
    "RQ_EMAIL",
    "RQ_PHONE",
    "RQ_FAX",
    "RQ_IDENT_DOC",
    "RQ_IDENT_DOC_SER",
    "RQ_IDENT_DOC_NUM",
    "RQ_IDENT_DOC_DATE",
    "RQ_IDENT_DOC_ISSUED_BY",
    "RQ_IDENT_DOC_DEP_CODE",
    "RQ_IFNS",
    "RQ_OGRNIP",
    "RQ_OKVED"
  ]
}

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

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 — Ошибки.

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

Список сокращается по мере наполнения шаблона. Каждое добавленное поле исчезает из списка доступных. Форма пустой коллекции сохраняется такой, какой её вернул Битрикс24. Отсутствующий или равный null результат заменяется на [].

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