метод REST scope: disk

disk.storage.getFields

Получить описание полей хранилища

Кто может выполнять: любой пользователь

Описание

Метод disk.storage.getFields возвращает описание полей хранилища.

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.getFields

Ответ

HTTP-статус: 200

{
    "result": {
        "ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "NAME": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "CODE": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "MODULE_ID": {
            "TYPE": "string",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        },
        "ENTITY_TYPE": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "ENTITY_ID": {
            "TYPE": "string",
            "USE_IN_FILTER": true,
            "USE_IN_SHOW": true
        },
        "ROOT_OBJECT_ID": {
            "TYPE": "integer",
            "USE_IN_FILTER": false,
            "USE_IN_SHOW": true
        }
    },
    "time": {
        "start": 1769541038,
        "finish": 1769541038.113711,
        "duration": 0.11371111869812012,
        "processing": 0,
        "date_start": "2026-01-26T15:10:38+03:00",
        "date_finish": "2026-01-26T15:10:38+03:00",
        "operating_reset_at": 1769541638,
        "operating": 0
    }
}

Возвращаемые данные

result array

Массив с описанием полей хранилища.

Структура описания каждого поля:
- TYPE — тип данных поля
- USE_IN_FILTER — возможность использовать поле при фильтрации
- USE_IN_SHOW — доступность поля при получении ответа

ID integer

Идентификатор хранилища

NAME string

Имя хранилища

CODE string

Символьный код хранилища

MODULE_ID string

Идентификатор модуля, которому принадлежит хранилище

ENTITY_TYPE string

Тип объекта, с которым связано хранилище.

Возможные значения:
- user — хранилище пользователя
- common — хранилище общих документов
- group — хранилище группы

ENTITY_ID string

Идентификатор объекта, с которым связано хранилище

ROOT_OBJECT_ID integer

Идентификатор корневой папки хранилища

time time

Информация о времени выполнения запроса

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.