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

Получить поле шаблона

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

Возвращает одну строку поля по её идентификатору в шаблоне реквизитов.

Параметры

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

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Поле:', data.fieldName, '— порядок:', data.sort)

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

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

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

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata Типobject ОписаниеОбъект строки поля шаблона
Полеdata.id Типnumber ОписаниеИдентификатор строки поля в шаблоне
Полеdata.fieldName Типstring ОписаниеСистемное имя поля реквизита: RQ_INN, RQ_COMPANY_NAME и др.
Полеdata.fieldTitle Типstring ОписаниеЗаголовок поля. Если не переопределён, при одиночном чтении возвращается название по умолчанию, например «ИНН» для RQ_INN
Полеdata.inShortList Типboolean ОписаниеОтображается ли поле в кратком списке реквизитов
Полеdata.sort Типnumber ОписаниеПорядок сортировки поля в шаблоне

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

JSON 
{
  "success": true,
  "data": {
    "id": 1,
    "fieldName": "RQ_INN",
    "fieldTitle": "ИНН",
    "inShortList": true,
    "sort": 500
  }
}

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

404 — поле не найдено:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "The PresetField with ID '99999' is not found"
  }
}

Ошибки

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

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

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

Флаг inShortList — булев. Поле приходит со значением true или false, а не Y/N.

fieldTitle содержит название по умолчанию. Даже когда заголовок поля не переопределён, чтение одной записи возвращает его название — «ИНН» для RQ_INN, «Контактное лицо» для RQ_CONTACT. В списке полей то же поле придёт с fieldTitle: "".

id поля — не то же самое, что fieldName. Параметр id в пути — числовой идентификатор строки поля в шаблоне — поле id из ответа GET /v1/requisite-presets/:presetId/fields, а не системное имя поля fieldName. Для поиска поля по имени используйте GET /v1/requisite-presets/:presetId/fields?filter[fieldName]=RQ_INN.

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