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

Scope: disk

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

Метод 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
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"filter":{"NAME":"%Битрикс24%"},"order":{"NAME":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/disk.storage.getlist
        
// callListMethod: Получает все данные сразу.
        // Используйте только для небольших выборок (< 1000 элементов) из-за высокой
        // нагрузки на память.
        
        try {
        const response = await $b24.callListMethod(
            'disk.storage.getlist',
            {
            filter: {
                NAME: '%Битрикс24%',
            },
            order: {
                NAME: 'DESC'
            }
            },
            (progress) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Выбирает данные по частям с помощью итератора.
        // Используйте для больших объемов данных для эффективного потребления памяти.
        
        try {
        const generator = $b24.fetchListMethod('disk.storage.getlist', {
            filter: {
            NAME: '%Битрикс24%',
            },
            order: {
            NAME: 'DESC'
            }
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // callMethod: Ручное управление постраничной навигацией через параметр start.
        // Используйте для точного контроля над пакетами запросов.
        // Для больших данных менее эффективен, чем fetchListMethod.
        
        try {
        const response = await $b24.callMethod('disk.storage.getlist', {
            filter: {
            NAME: '%Битрикс24%',
            },
            order: {
            NAME: 'DESC'
            }
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.storage.getlist',
                    [
                        'filter' => [
                            'NAME' => '%Битрикс24%',
                        ],
                        'order' => [
                            'NAME' => 'DESC'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching storage list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "disk.storage.getlist",
            {
                filter: {
                    NAME: '%Битрикс24%',
                },
                order: {
                    NAME: 'DESC'
                }
            },
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'disk.storage.getlist',
            [
                'filter' => [
                    'NAME' => '%Битрикс24%',
                ],
                'order' => [
                    'NAME' => 'DESC'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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

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

Обработка ошибок

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить описание хранилища приложения
Следующая
Получить типы хранилищ