# disk.file.getFields

URL: https://chugunov.pro/api-bitrix24/disk/file/disk-file-get-fields/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить описание полей файла
Scope: `disk`
Кто может выполнять метод: любой пользователь

## Описание

Метод `disk.file.getFields` возвращает описание полей файла.

## Ответ

HTTP-статус: 200

```json
{
    "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+03:00",
        "date_finish": "2026-02-09T16:38:38+03:00",
        "operating_reset_at": 1770652118,
        "operating": 0
    }
}
```

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

- `result` `array`. Массив с описанием полей файла.
  Структура описания каждого поля:
  - `TYPE` — тип данных поля
  - `USE_IN_FILTER` — возможность использовать поле при фильтрации
  - `USE_IN_SHOW` — доступность поля при получении ответа
- `ID` `integer`. Идентификатор файла
- `NAME` `string`. Имя файла
- `TYPE` `enum`. Тип объекта
- `CODE` `string`. Символьный код файла
- `STORAGE_ID` `integer`. Идентификатор хранилища, в котором находится файл
- `PARENT_ID` `integer`. Идентификатор родительской папки
- `CREATE_TIME` `datetime`. Дата и время создания файла
- `UPDATE_TIME` `datetime`. Дата и время последнего обновления файла
- `DELETE_TIME` `datetime`. Дата и время переноса файла в корзину
- `CREATED_BY` `integer`. Идентификатор пользователя, создавшего файл
- `UPDATED_BY` `integer`. Идентификатор пользователя, внесшего последнее изменение
- `DELETED_BY` `integer`. Идентификатор пользователя, удалившего файл
- `GLOBAL_CONTENT_VERSION` `integer`. Инкрементальный счетчик версии файла
- `FILE_ID` `integer`. Внутреннее значение идентификатора файла
- `SIZE` `integer`. Размер файла в байтах
- `DELETED_TYPE` `enum`. Статус удаления объекта
- `time` `time`. Информация о времени выполнения запроса

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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",
        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}")
```

### PHP

```php
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.js

```js
BX24.callMethod(
    "disk.file.getFields",
    {},
    function (result)
    {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'disk.file.getFields',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
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("ожидался объект в ответе")
}
fmt.Println("полей в ответе:", len(keys))
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/disk/file/disk-file-get-fields.html