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

Поля файла

GET /v1/files/fields

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

Примеры

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

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

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

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

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

Поля ответа

Таблица описывает обёртку ответа и поля схемы data.fields. Для полей файла указан тип их значений. Каждое поле схемы — объект с ключами type, readonly, label и description.

Подписи полей label и description приходят на русском языке. Заголовками запроса язык не переключается.

Поле Битрикс24 Тип RO Описание
Полеsuccess Битрикс24 Типboolean RO ОписаниеВсегда true при успехе
Полеdata Битрикс24 Типobject RO ОписаниеСхема файла и доступные операции
Полеdata.fields Битрикс24 Типobject RO ОписаниеСловарь полей файла: ключ — имя поля, значение — объект с описанием. Поля словаря перечислены ниже
Полеdata.relations Битрикс24 Типobject RO ОписаниеСвязи файла. Связь folder описывает родительскую папку и доступна для включения в ответ
Полеdata.batch Битрикс24 Типarray RO ОписаниеОперации записи, доступные в пакетных вызовах: update, delete
Полеdata.include Битрикс24 Типarray RO ОписаниеИмена связей, которые принимает параметр include: folder
Полеid Битрикс24ID Типnumber ROда ОписаниеИдентификатор объекта
Полеname Битрикс24NAME Типstring RO ОписаниеИмя файла или папки
Полеsize Битрикс24SIZE Типnumber ROда ОписаниеРазмер файла в байтах. Приходит у записей-файлов
ПолеfolderId Битрикс24PARENT_ID Типnumber RO ОписаниеID родительской папки. Список папок: GET /v1/folders
ПолеstorageId Битрикс24STORAGE_ID Типnumber ROда ОписаниеID хранилища. Список: GET /v1/storages
Полеtype Битрикс24TYPE Типstring ROда ОписаниеТип объекта: "file" или "folder"
Полеcode Битрикс24CODE Типstring RO ОписаниеСимвольный код объекта
ПолеfileId Битрикс24FILE_ID Типnumber ROда ОписаниеВнутренний ID файла. Приходит у записей-файлов
ПолеdownloadUrl Битрикс24DOWNLOAD_URL Типstring ROда ОписаниеАдрес скачивания через API Вайбкод — GET /v1/files/:id/download. Приходит у записей-файлов. Запрос по нему передаёт заголовок X-Api-Key
ПолеdetailUrl Битрикс24DETAIL_URL Типstring ROда ОписаниеСсылка на объект в интерфейсе
ПолеcontentProvider Битрикс24CONTENT_PROVIDER Типstring ROда ОписаниеПровайдер контента. Возвращается только у файлов из внешних провайдеров контента — у файлов на Диске Битрикс24 не возвращается
ПолеglobalContentVersion Битрикс24GLOBAL_CONTENT_VERSION Типnumber ROда ОписаниеСчётчик версий файла. Приходит у записей-файлов
ПолеdeletedType Битрикс24DELETED_TYPE Типnumber ROда ОписаниеСтатус удаления: 0 — не удалён, 3 — в корзине, 4 — удалён вместе с папкой
ПолеrealObjectId Битрикс24REAL_OBJECT_ID Типnumber ROда ОписаниеВнутренний ID объекта
ПолеcreatedBy Битрикс24CREATED_BY Типnumber ROда ОписаниеID пользователя-создателя. Поиск: GET /v1/users
ПолеupdatedBy Битрикс24UPDATED_BY Типnumber ROда ОписаниеID автора последнего изменения. Поиск: GET /v1/users
ПолеdeletedBy Битрикс24DELETED_BY Типnumber ROда ОписаниеID пользователя, удалившего объект. Поиск: GET /v1/users
ПолеcreatedAt Битрикс24CREATE_TIME Типdatetime ROда ОписаниеДата и время создания (ISO 8601 UTC)
ПолеupdatedAt Битрикс24UPDATE_TIME Типdatetime ROда ОписаниеДата и время последнего изменения
ПолеdeletedAt Битрикс24DELETE_TIME Типdatetime ROда ОписаниеДата и время удаления. Значение null — объект не удалён

Поля name, folderId и code доступны при создании и обновлении объекта. Через PATCH /v1/files/:id обновляется только поле name.

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

JSON 
{
  "success": true,
  "data": {
    "fields": {
      "id": { "type": "number", "readonly": true, "label": "ID", "description": "Идентификатор файла или папки на Диске." },
      "name": { "type": "string", "readonly": false, "label": "Имя", "description": "Имя файла или папки." },
      "size": { "type": "number", "readonly": true, "label": "Размер", "description": "Размер файла в байтах; указывается только для записей-файлов." },
      "folderId": { "type": "number", "readonly": false, "label": "ID папки", "description": "Идентификатор родительской папки, в которой находится объект." },
      "storageId": { "type": "number", "readonly": true, "label": "ID хранилища", "description": "Идентификатор хранилища Диска, к которому относится объект." },
      "type": { "type": "string", "readonly": true, "label": "Тип объекта", "description": "Тип объекта — файл или папка." },
      "code": { "type": "string", "readonly": false, "label": "Символьный код", "description": "Символьный код объекта, заданный при создании или обновлении." },
      "fileId": { "type": "number", "readonly": true, "label": "ID файла", "description": "Внутренний идентификатор файла; указывается только для записей-файлов." },
      "downloadUrl": { "type": "string", "readonly": true, "label": "Ссылка на скачивание", "description": "Адрес API Вайбкод для скачивания файла: GET /v1/files/{id}/download. Передайте заголовок X-Api-Key ключа со скоупом disk или crm." },
      "detailUrl": { "type": "string", "readonly": true, "label": "Ссылка на объект", "description": "Ссылка на просмотр объекта в интерфейсе Битрикс24." },
      "contentProvider": { "type": "string", "readonly": true, "label": "Провайдер контента", "description": "Внешний провайдер контента; для файлов на Диске Битрикс24 не возвращается." },
      "globalContentVersion": { "type": "number", "readonly": true, "label": "Версия контента", "description": "Счётчик версий содержимого файла." },
      "deletedType": { "type": "number", "readonly": true, "label": "Статус удаления", "description": "Удалён ли объект и каким образом — не удалён, в корзине или удалён вместе с папкой." },
      "createdBy": { "type": "number", "readonly": true, "label": "Автор создания", "description": "Идентификатор пользователя, создавшего объект." },
      "updatedBy": { "type": "number", "readonly": true, "label": "Автор изменения", "description": "Идентификатор пользователя, последним изменившего объект." },
      "createdAt": { "type": "datetime", "readonly": true, "label": "Дата создания", "description": "Дата и время создания объекта." },
      "updatedAt": { "type": "datetime", "readonly": true, "label": "Дата изменения", "description": "Дата и время последнего изменения объекта." },
      "deletedAt": { "type": "datetime", "readonly": true, "label": "Дата удаления", "description": "Дата и время удаления объекта; null, если объект не удалён." },
      "realObjectId": { "type": "number", "readonly": true, "label": "Внутренний ID", "description": "Внутренний идентификатор объекта на Диске." },
      "deletedBy": { "type": "number", "readonly": true, "label": "Автор удаления", "description": "Идентификатор пользователя, удалившего объект; null, если объект не удалён." }
    },
    "relations": {
      "folder": { "type": "one", "entity": "folders", "includable": true }
    },
    "batch": ["update", "delete"],
    "include": ["folder"]
  }
}

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

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

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

Ошибки

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

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

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