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

Scope: disk

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

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

Параметры метода

Без параметров.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

try
        {
            const response = await $b24.callMethod(
                'disk.storage.getfields',
                {}
            );
            
            const result = response.getData().result;
            console.log('Retrieved fields:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'disk.storage.getfields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error retrieving fields: ' . $e->getMessage();
        }

BX24.callMethod(
            "disk.storage.getfields",
            {},
            function (result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'disk.storage.getfields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

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`	Информация о времени выполнения запроса

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

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

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

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

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

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

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

Параметры методаПараметры метода

Примеры кодаПримеры кода

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

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

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

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

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