Получить список файлов и папок в корне хранилища disk.storage.getchildren
Scope:
diskКто может выполнять метод: любой пользователь
Метод disk.storage.getchildren возвращает список файлов и папок, которые находятся в корне хранилища.
Возвращаются только те файлы и папки, к которым у пользователя есть право «Чтение»
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор хранилища. Идентификатор можно получить с помощью метода disk.storage.getlist |
|
filter |
Массив формата:
где:
К ключам
Список доступных для фильтрации полей можно узнать с помощью метода disk.folder.getfields |
|
order |
Массив формата:
где:
Список доступных для сортировки полей можно узнать с помощью метода disk.folder.getfields |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1357,"filter":{"NAME":"%Папка%"},"order":{"NAME":"DESC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/disk.storage.getchildren
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1357,"filter":{"NAME":"%Папка%"},"order":{"NAME":"DESC"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/disk.storage.getchildren
try
{
const response = await $b24.callMethod(
'disk.storage.getchildren',
{
id: 1357,
filter: {
NAME: '%Папка%',
},
order: {
NAME: 'DESC',
}
}
);
const result = response.getData().result;
console.log('Retrieved children:', result);
processResult(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'disk.storage.getchildren',
[
'id' => 1357,
'filter' => [
'NAME' => '%Папка%'
],
'order' => [
'NAME' => 'DESC'
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error retrieving children: ' . $e->getMessage();
}
BX24.callMethod(
"disk.storage.getchildren",
{
id: 1357,
filter: {
NAME: '%Папка%'
},
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.getchildren',
[
'id' => 1357,
'filter' => [
'NAME' => '%Папка%'
],
'order' => [
'NAME' => 'DESC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": [
{
"ID": "8960",
"NAME": "Папка в папке",
"CODE": null,
"STORAGE_ID": "1357",
"TYPE": "folder",
"REAL_OBJECT_ID": "8960",
"PARENT_ID": "8875",
"DELETED_TYPE": "0",
"CREATE_TIME": "2026-01-14T15:01:14+03:00",
"UPDATE_TIME": "2026-01-14T15:01:14+03:00",
"DELETE_TIME": null,
"CREATED_BY": "1269",
"UPDATED_BY": "1269",
"DELETED_BY": "0",
"DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/path/Папка в папке"
},
{
"ID": "8907",
"NAME": "Папка",
"CODE": null,
"STORAGE_ID": "1357",
"TYPE": "folder",
"REAL_OBJECT_ID": "8907",
"PARENT_ID": "8875",
"DELETED_TYPE": "0",
"CREATE_TIME": "2025-12-30T14:16:49+03:00",
"UPDATE_TIME": "2026-01-21T13:53:51+03:00",
"DELETE_TIME": null,
"CREATED_BY": "1269",
"UPDATED_BY": "1269",
"DELETED_BY": "0",
"DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/path/Папка"
},
{
"ID": "9023",
"NAME": "Новая папка",
"CODE": null,
"STORAGE_ID": "1357",
"TYPE": "folder",
"REAL_OBJECT_ID": "9023",
"PARENT_ID": "8875",
"DELETED_TYPE": "0",
"CREATE_TIME": "2026-01-26T13:30:15+03:00",
"UPDATE_TIME": "2026-01-26T13:30:15+03:00",
"DELETE_TIME": null,
"CREATED_BY": "1269",
"UPDATED_BY": "1269",
"DELETED_BY": null,
"DETAIL_URL": "https://test.bitrix24.ru/company/personal/user/1269/disk/path/Новая папка"
}
],
"total": 3,
"time": {
"start": 1769539624,
"finish": 1769539624.498846,
"duration": 0.49884605407714844,
"processing": 0,
"date_start": "2026-01-26T14:47:04+03:00",
"date_finish": "2026-01-26T14:47:04+03:00",
"operating_reset_at": 1769540224,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Список файлов и папок с описанием полей. Пустой массив означает, что у пользователя нет прав на просмотр файлов и папок, находящихся в корне хранилища |
|
ID |
Идентификатор файла/папки |
|
NAME |
Имя файла/папки |
|
CODE |
Символьный код файла/папки |
|
STORAGE_ID |
Идентификатор хранилища, в котором находится файл/папка |
|
TYPE |
Тип объекта |
|
REAL_OBJECT_ID |
Идентификатор объекта |
|
PARENT_ID |
Идентификатор родительской папки |
|
DELETED_TYPE |
Статус удаления объекта. Возможные значения:
|
|
GLOBAL_CONTENT_VERSION |
Инкрементальный счетчик версии файла |
|
FILE_ID |
Внутреннее значение идентификатора файла |
|
SIZE |
Размер файла в байтах |
|
CREATE_TIME |
Дата и время создания файла/папки |
|
UPDATE_TIME |
Дата и время последнего обновления файла/папки |
|
DELETE_TIME |
Дата и время переноса файла/папки в корзину |
|
CREATED_BY |
Идентификатор пользователя, создавшего файл/папку |
|
UPDATED_BY |
Идентификатор пользователя, внесшего последнее изменение |
|
DELETED_BY |
Идентификатор пользователя, удалившего файл/папку |
|
DOWNLOAD_URL |
Ссылка для скачивания файла |
|
DETAIL_URL |
Ссылка для открытия файла/папки в интерфейсе |
|
total |
Общее количество файлов и папок |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_ARGUMENT",
"error_description":"Invalid value of parameter {Parameter #0}"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Invalid value of parameter |
Не указан обязательный параметр |
|
|
Could not find entity with id |
Хранилище с указанным |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Создать папку в корне хранилища disk.storage.addfolder
- Получить описание полей хранилища disk.storage.getfields
- Получить описание хранилища приложения disk.storage.getforapp
- Получить список доступных хранилищ disk.storage.getlist
- Получить типы хранилищ disk.storage.gettypes
- Получить описание хранилища disk.storage.get
- Переименовать хранилище приложения disk.storage.rename
- Загрузить новый файл в корень хранилища disk.storage.uploadfile