Get Description of File Fields for disk.file.getFields
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
diskWho can execute the method: any user
The method disk.file.getFields returns the description of file 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.file.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.file.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 FieldItem = {
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 DiskFileFieldsResult = Record<string, FieldItem>
try {
const response = await $b24.actions.v2.call.make<DiskFileFieldsResult>({
method: 'disk.file.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('File fields:', Object.keys(result))
}
} 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 getDiskFileFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'disk.file.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('File fields:', Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getDiskFileFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.disk.file.getfields().response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'disk.file.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting file fields: ' . $e->getMessage();
}
BX24.callMethod(
"disk.file.getFields",
{},
function (result)
{
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'disk.file.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "disk.file.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("disk.file.getFields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))
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
},
"TYPE": {
"TYPE": "enum",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CODE": {
"TYPE": "string",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"STORAGE_ID": {
"TYPE": "integer",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"PARENT_ID": {
"TYPE": "integer",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CREATE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"UPDATE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"DELETE_TIME": {
"TYPE": "datetime",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
},
"CREATED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"UPDATED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"DELETED_BY": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"GLOBAL_CONTENT_VERSION": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"FILE_ID": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"SIZE": {
"TYPE": "integer",
"USE_IN_FILTER": false,
"USE_IN_SHOW": true
},
"DELETED_TYPE": {
"TYPE": "enum",
"USE_IN_FILTER": true,
"USE_IN_SHOW": true
}
},
"time": {
"start": 1770651518,
"finish": 1770651518.741429,
"duration": 0.7414290904998779,
"processing": 0,
"date_start": "2026-02-09T16:38:38+01:00",
"date_finish": "2026-02-09T16:38:38+01:00",
"operating_reset_at": 1770652118,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Array with the description of file fields. The structure of each field description:
|
|
ID |
File identifier |
|
NAME |
File name |
|
TYPE |
Object type |
|
CODE |
Symbolic code of the file |
|
STORAGE_ID |
Identifier of the storage where the file is located |
|
PARENT_ID |
Identifier of the parent folder |
|
CREATE_TIME |
Date and time of file creation |
|
UPDATE_TIME |
Date and time of the last file update |
|
DELETE_TIME |
Date and time the file was moved to the trash |
|
CREATED_BY |
Identifier of the user who created the file |
|
UPDATED_BY |
Identifier of the user who made the last change |
|
DELETED_BY |
Identifier of the user who deleted the file |
|
GLOBAL_CONTENT_VERSION |
Incremental version counter of the file |
|
FILE_ID |
Internal value of the file identifier |
|
SIZE |
Size of the file in bytes |
|
DELETED_TYPE |
Status of the object's deletion |
|
time |
Information about the execution time of the request |
Error Handling
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- Copy File to Specified Folder disk.file.copyTo
- Permanently Delete File disk.file.delete
- Get Public Link for File disk.file.getExternalLink
- List of File Versions for disk.file.getVersions
- Get File Parameters disk.file.get
- Move File to Trash disk.file.markDeleted
- Move File to Specified Folder disk.file.moveTo
- Rename File disk.file.rename
- Restore a File from a Specific Version disk.file.restoreFromVersion
- Restore File from Trash disk.file.restore
- Search Files and Folders disk.file.search
- Upload a New Version of a File disk.file.uploadVersion