Get Description of File Fields for disk.file.getfields

Scope: disk

Who 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 (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.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

try
        {
            const response = await $b24.callMethod(
                'disk.file.getfields',
                {}
            );
            
            const result = response.getData().result;
            console.log('File fields:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('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>';

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 `type`	Description
result `array`	Array with the description of file fields. The structure of each field description: `TYPE` — data type of the field `USE_IN_FILTER` — ability to use the field in filtering `USE_IN_SHOW` — availability of the field in the response
ID `integer`	File identifier
NAME `string`	File name
TYPE `enum`	Object type
CODE `string`	Symbolic code of the file
STORAGE_ID `integer`	Identifier of the storage where the file is located
PARENT_ID `integer`	Identifier of the parent folder
CREATE_TIME `datetime`	Date and time of file creation
UPDATE_TIME `datetime`	Date and time of the last file update
DELETE_TIME `datetime`	Date and time the file was moved to the trash
CREATED_BY `integer`	Identifier of the user who created the file
UPDATED_BY `integer`	Identifier of the user who made the last change
DELETED_BY `integer`	Identifier of the user who deleted the file
GLOBAL_CONTENT_VERSION `integer`	Incremental version counter of the file
FILE_ID `integer`	Internal value of the file identifier
SIZE `integer`	Size of the file in bytes
DELETED_TYPE `enum`	Status of the object's deletion
time `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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Get Public Link to File

Get a List of File Versions

Get Description of File Fields for disk.file.getfields

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning