Файлы свойства элемента

GET /v1/lists/:iblockId/elements/:elementId/files/:fieldId

Возвращает ссылки на файлы, сохранённые в свойстве элемента типа Файл.

Параметры

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

Примеры

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/elements/501/files/1149 \
  -H "X-Api-Key: YOUR_API_KEY"

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

Terminal 
curl https://vibecode.bitrix24.tech/v1/lists/121/elements/501/files/1149 \
  -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/elements/501/files/1149', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Ссылки на файлы:', data)

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

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Ссылки на файлы свойства. Для свойства не файлового типа — пустой массив

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

Свойство без файлов или не файлового типа возвращает пустой массив:

JSON 
{
  "success": true,
  "data": []
}

Свойство типа Файл возвращает массив ссылок на файлы для скачивания.

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

400 — fieldId передан с префиксом PROPERTY_:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "fieldId must be the numeric property id WITHOUT the PROPERTY_ prefix (e.g. 423, not PROPERTY_423)."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS fieldId передан с префиксом PROPERTY_ или не является числом
400 INVALID_PARAMS elementId не является положительным целым числом
400 INVALID_IBLOCK_TYPE iblockTypeId не входит в набор lists, bitrix_processes, lists_socnet
403 BITRIX_ACCESS_DENIED Нет доступа к списку или список не существует
409 LISTS_MODULE_NOT_ENABLED На портале не подключён модуль «Списки»
403 SCOPE_DENIED Ключу не хватает скоупа lists
401 TOKEN_MISSING У ключа не настроены токены доступа

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

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

Идентификатор свойства в этом маршруте передаётся голым числом без префикса PROPERTY_ — 1149, а не PROPERTY_1149. Маршруты полей списка адресуют то же свойство как PROPERTY_<id>. Передача идентификатора с префиксом возвращает 400 INVALID_PARAMS.

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