метод REST scope: disk

disk.storage.getList

Получить список доступных хранилищ

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

Описание

Метод disk.storage.getList возвращает список доступных хранилищ.

Параметры

filter array необязательный

Массив формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}

где:
- field_n — название поля, по которому будет произведена фильтрация
- value_n — значение фильтра

К ключам field_n можно добавить префикс, уточняющий работу фильтра.
Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

Список доступных для фильтрации полей можно узнать с помощью метода disk.storage.getFields

order array необязательный

Массив формата:

{
    field_1: value_1,
    field_2: value_2,
    ...,
    field_n: value_n,
}

где:
- field_n — название поля, по которому будет произведена сортировка
- value_n — значение типа string, равное:
- ASC — сортировка по возрастанию
- DESC — сортировка по убыванию

Список доступных для сортировки полей можно узнать с помощью метода disk.storage.getFields

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 50, где N — номер нужной страницы

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"NAME":"%Битрикс24%"},"order":{"NAME":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.getList

Ответ

HTTP-статус: 200

{
    "result": [
        {
        "ID": "13",
        "NAME": "Поддержка Битрикс24",
        "CODE": null,
        "MODULE_ID": "disk",
        "ENTITY_TYPE": "user",
        "ENTITY_ID": "3",
        "ROOT_OBJECT_ID": "21"
        },
        {
        "ID": "1335",
        "NAME": "Модуль интеграции Битрикс24",
        "CODE": null,
        "MODULE_ID": "disk",
        "ENTITY_TYPE": "user",
        "ENTITY_ID": "1255",
        "ROOT_OBJECT_ID": "8755"
        }
    ],
    "total": 2,
    "time": {
        "start": 1770044358,
        "finish": 1770044358.241043,
        "duration": 0.2410430908203125,
        "processing": 0,
        "date_start": "2026-02-02T11:29:18+03:00",
        "date_finish": "2026-02-02T11:29:18+03:00",
        "operating_reset_at": 1770044958,
        "operating": 0
    }
}

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

result array

Массив доступных хранилищ.

Пустой массив означает, что у пользователя нет доступа к хранилищам или нет записей, удовлетворяющих фильтру

ID integer

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

NAME string

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

CODE string

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

MODULE_ID string

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

ENTITY_TYPE string

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

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

ENTITY_ID string

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

ROOT_OBJECT_ID integer

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

total integer

Общее количество найденных записей

time time

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

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

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