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

Типы полей

GET /v1/lists/:iblockId/field-types

Помогает выбрать тип поля перед его созданием в списке.

Параметры

Параметр Тип Обяз. Описание
iblockId (path) string да Идентификатор списка. Числовой IBLOCK_ID или символьный IBLOCK_CODE. Получить идентификатор — Список списков
iblockTypeId (query) string нет Тип инфоблока. Значения:
lists — обычные списки, по умолчанию
lists_socnet — списки рабочих групп
bitrix_processes — служебные бизнес-процессы
structure — тип структуры компании (здесь лежит штатный инфоблок графика отсутствий absence)
socnetGroupId (query) number нет Идентификатор рабочей группы для списков типа lists_socnet. Положительное целое число из поля id метода Список рабочих групп
fieldId (query) string нет Идентификатор существующего поля. Значение FIELD_ID из ответа метода Поля списка. Если указан, тип этого поля включается в справочник. Например, fieldId=NAME добавляет код NAME

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/field-types \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/field-types \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/field-types', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Название типа S:', data['S'])

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/lists/121/field-types', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data object Справочник типов. Ключ — код типа поля, значение — строка с русским названием

Составные коды записываются через двоеточие — S:Date, E:EList, S:Money. В fields.TYPE передаётся код, а не название типа.

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

JSON 
{
  "success": true,
  "data": {
    "SORT": "Сортировка",
    "ACTIVE_FROM": "Начало активности",
    "ACTIVE_TO": "Окончание активности",
    "PREVIEW_PICTURE": "Изображение для анонса",
    "PREVIEW_TEXT": "Текст анонса",
    "DETAIL_PICTURE": "Детальное изображение",
    "DETAIL_TEXT": "Детальный текст",
    "CREATED_BY": "Кем создан",
    "TIMESTAMP_X": "Дата изменения",
    "S": "Строка",
    "N": "Число",
    "L": "Список",
    "F": "Файл",
    "G": "Привязка к разделам",
    "E": "Привязка к элементам",
    "S:Date": "Дата",
    "S:DateTime": "Дата/Время",
    "S:HTML": "HTML/текст",
    "E:EList": "Привязка к элементам в виде списка",
    "N:Sequence": "Счетчик",
    "S:ECrm": "Привязка к элементам CRM",
    "S:Money": "Деньги",
    "S:DiskFile": "Файл (Диск)",
    "S:map_yandex": "Привязка к Яндекс.Карте",
    "S:employee": "Привязка к сотруднику"
  }
}

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

404 — списка с указанным идентификатором нет:

JSON 
{
  "success": false,
  "error": {
    "code": "LIST_NOT_FOUND",
    "message": "List not found"
  }
}

Ошибки

HTTP Код Описание
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в список допустимых типов
403 BITRIX_ACCESS_DENIED Нет прав на просмотр и редактирование списка
404 LIST_NOT_FOUND Списка с указанным iblockId не существует
409 LISTS_MODULE_NOT_ENABLED На портале не подключён модуль списков
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа нет настроенных токенов

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

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

Системные поля тоже можно добавлять в список. В справочнике есть как типы пользовательских полей — S, N, S:Date, так и коды системных полей — SORT, ACTIVE_FROM, CREATED_BY, TIMESTAMP_X. Например, fields.TYPE=SORT в методе Создать поле добавляет системное поле сортировки.

После добавления SORT этот код исчезает из справочника доступных типов. Чтобы получить его снова вместе с остальными типами, передайте fieldId=SORT.

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