Get Description of Storage Fields disk.storage.getfields
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
diskWho can execute the method: any user
The method disk.storage.getfields returns the description of storage fields.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
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>
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>';
Response Handling
HTTP status: 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+02:00",
"date_finish": "2026-01-26T15:10:38+02:00",
"operating_reset_at": 1769541638,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array with the description of storage fields. The structure of the description for each field:
|
|
ID |
Identifier of the storage |
|
NAME |
Name of the storage |
|
CODE |
Symbolic code of the storage |
|
MODULE_ID |
Identifier of the module to which the storage belongs |
|
ENTITY_TYPE |
Type of the object associated with the storage. Possible values:
|
|
ENTITY_ID |
Identifier of the object associated with the storage |
|
ROOT_OBJECT_ID |
Identifier of the root folder of the storage |
|
time |
Information about the execution time of the request |
Error Handling
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Create a Folder in the Root of the Storage disk.storage.addfolder
- Get a list of files and folders in the root of the storage disk.storage.getchildren
- Get Application Storage Description disk.storage.getforapp
- Get a List of Available Storages disk.storage.getlist
- Get Storage Types disk.storage.gettypes
- Get Storage Description disk.storage.get
- Rename Application Storage disk.storage.rename
- Upload a New File to the Root of the Storage disk.storage.uploadfile