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
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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldDescriptor = {
TYPE: string
USE_IN_FILTER: boolean
USE_IN_SHOW: boolean
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type StorageFieldsResult = Record<string, FieldDescriptor>
try {
const response = await $b24.actions.v2.call.make<StorageFieldsResult>({
method: 'disk.storage.getFields',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Storage fields:', Object.keys(result))
console.info('ID field descriptor:', result['ID'])
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getStorageFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'disk.storage.getFields',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Storage fields:', Object.keys(result))
console.info('ID field descriptor:', result['ID'])
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getStorageFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.disk.storage.getfields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "disk.storage.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("disk.storage.getFields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
Ответ
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
Информация о времени выполнения запроса

