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

Поля шаблонов реквизитов

GET /v1/requisite-presets/fields

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

Примеры

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

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

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

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

const { success, data } = await res.json()
console.log('Всего полей:', Object.keys(data.fields).length)

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

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

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

Поля ответа

data.fields — объект, ключ которого совпадает с именем поля, а значение описывает поле: тип, доступно ли оно для записи, подпись и описание. Состав ключей разобран в таблице после списка полей. data.batch — операции шаблона, доступные в пакетном запросе.

Поле Тип RO Описание
Полеid Типnumber ROда ОписаниеИдентификатор шаблона
ПолеentityTypeId Типnumber ROнет ОписаниеТип сущности — всегда 8, реквизит. Задаётся при создании шаблона. В схеме помечен флагом createOnly, передача в теле обновления отклоняется с 400 READONLY_FIELD
ПолеcountryId Типnumber ROнет ОписаниеИдентификатор страны набора полей. Задаётся при создании шаблона. В схеме помечен флагом createOnly, передача в теле обновления отклоняется с 400 READONLY_FIELD
Полеname Типstring ROнет ОписаниеНазвание шаблона
Полеactive Типboolean ROнет ОписаниеАктивен ли шаблон
Полеsort Типnumber ROнет ОписаниеПорядок сортировки
ПолеxmlId Типstring ROнет ОписаниеВнешний идентификатор для синхронизации
ПолеcreatedAt Типdatetime ROда ОписаниеДата создания
ПолеupdatedAt Типdatetime ROда ОписаниеДата последнего изменения
ПолеcreatedBy Типnumber ROда ОписаниеID пользователя, создавшего шаблон. Список: GET /v1/users
ПолеmodifyBy Типnumber ROда ОписаниеID пользователя, изменившего шаблон последним. Список: GET /v1/users

xmlId, updatedAt, modifyBy могут быть null. Поле createdBy равно 0 у шаблонов, созданных системой.

Ключи label и description в data.fields.<имя> приходят на русском языке. Заголовками запроса язык не переключается.

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.fields.<имя>.type Типstring ОписаниеТип поля: number, string, boolean, datetime
Полеdata.fields.<имя>.readonly Типboolean Описаниеtrue — поле заполняется системой и не принимается при создании и обновлении
Полеdata.fields.<имя>.createOnly Типboolean Описаниеtrue — поле задаётся только при создании, в теле обновления отклоняется с 400 READONLY_FIELD. Ключ есть у entityTypeId и countryId
Полеdata.fields.<имя>.label Типstring ОписаниеНазвание поля для отображения
Полеdata.fields.<имя>.description Типstring ОписаниеПояснение к полю
Полеdata.batch Типstring[] ОписаниеОперации шаблона, доступные в пакетном запросе: create, update, delete

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

В примере ключи label и description опущены для краткости.

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true },
      "entityTypeId": { "type": "number", "readonly": false, "createOnly": true },
      "countryId": { "type": "number", "readonly": false, "createOnly": true },
      "name": { "type": "string", "readonly": false },
      "active": { "type": "boolean", "readonly": false },
      "sort": { "type": "number", "readonly": false },
      "xmlId": { "type": "string", "readonly": false },
      "createdAt": { "type": "datetime", "readonly": true },
      "updatedAt": { "type": "datetime", "readonly": true },
      "createdBy": { "type": "number", "readonly": true },
      "modifyBy": { "type": "number", "readonly": true }
    },
    "batch": ["create", "update", "delete"]
  }
}

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

403 — нет скоупа:

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

Ошибки

HTTP Код Описание
HTTP403 КодSCOPE_DENIED ОписаниеAPI-ключ не имеет скоупа crm
HTTP401 КодTOKEN_MISSING ОписаниеAPI-ключ не имеет настроенных токенов
HTTP429 КодRATE_LIMITED ОписаниеПревышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Действующее значение — в заголовке x-ratelimit-limit. Повторите после срока из заголовка Retry-After

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

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