# note.file.field.list

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

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

## Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в [обзоре REST 3.0](https://chugunov.pro/api-bitrix24/rest-v3/).

Метод `note.file.field.list` возвращает список доступных полей файла документа.

## Параметры

- `select` `array` — необязательный. Список полей описания, которые нужно вернуть в ответе.
  Доступные поля:
  - `name` — имя поля
  - `type` — тип данных
  - `title` — заголовок
  - `description` — описание
  - `validationRules` — правила валидации
  - `requiredGroups` — группы обязательности
  - `filterable` — признак доступности в фильтре
  - `sortable` — признак доступности в сортировке
  - `editable` — признак редактируемости
  - `multiple` — признак множественного значения
  - `elementType` — тип элемента для составных полей

## Ответ

HTTP-статус: 200

```json
{
    "result": {
        "items": [
            {
                "name": "id",
                "type": "int",
                "title": "id",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "documentId",
                "type": "int",
                "title": "documentId",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "name",
                "type": "string",
                "title": "name",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "size",
                "type": "int",
                "title": "size",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "mimeType",
                "type": "string",
                "title": "mimeType",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "assetType",
                "type": "string",
                "title": "assetType",
                "filterable": false,
                "sortable": false
            },
            {
                "name": "assetMarkdown",
                "type": "string",
                "title": "assetMarkdown",
                "filterable": false,
                "sortable": false
            }
        ]
    },
    "time": {
        "start": 1780803600,
        "finish": 1780803600.111144,
        "duration": 0.1111440658569336,
        "processing": 0,
        "date_start": "2026-06-22T09:40:00+03:00",
        "date_finish": "2026-06-22T09:40:00+03:00",
        "operating_reset_at": 1780804200,
        "operating": 0
    }
}
```

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

- `result` `object`. Объект с данными ответа
- `items` `array`. Массив объектов с описанием полей. Структура ответа зависит от `select`
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
        "message": "Неизвестное поле `unknownField` для сущности `DtoFieldDto`"
    }
}
```

- `Поле` — **Описание ошибки**. **Как исправить**
- — — Доступ запрещен. Проверьте права пользователя и scope `note`

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

### cURL (Webhook)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","filterable","sortable"]}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/note.file.field.list
```

### cURL (OAuth)

```bash
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["name","type","title","filterable","sortable"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/note.file.field.list
```

### JS (TS)

```ts
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type FileFieldItem = {
  name: string
  type: string
  title: string
  filterable: boolean
  sortable: boolean
}

type FileFieldListResult = {
  items: FileFieldItem[]
}

try {
  const response = await $b24.actions.v3.call.make<FileFieldListResult>({
    method: 'note.file.field.list',
    params: {
      select: [
        'name',
        'type',
        'title',
        'filterable',
        'sortable',
      ],
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('File fields:', result.items)
  }
} catch (error) {
  console.error(error)
}
```

### JS (UMD)

```html
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function listFileFields() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'note.file.field.list',
        params: {
          select: [
            'name',
            'type',
            'title',
            'filterable',
            'sortable',
          ],
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('File fields:', result.items)
    } catch (error) {
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listFileFields)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

select = [
    "name",
    "type",
    "title",
    "filterable",
    "sortable",
]

try:
    bitrix_response = client.note.file.field.list(
        select=select,
    ).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(
            'note.file.field.list',
            [
                'select' => [
                    'name',
                    'type',
                    'title',
                    'filterable',
                    'sortable'
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'note.file.field.list',
    {
        select: [
            'name',
            'type',
            'title',
            'filterable',
            'sortable'
        ]
    },
    function(result){
        console.info(result.data());
        console.log(result);
    }
);
```

### PHP CRest

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

$result = CRest::call(
    'note.file.field.list',
    [
        'select' => [
            'name',
            'type',
            'title',
            'filterable',
            'sortable'
        ]
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "note.file.field.list", b24.Params{
	"select": []string{"name", "type", "title", "filterable", "sortable"},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("note.file.field.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "items".
raw, ok := b24.Unwrap(res.Result, "items")
if !ok {
	return fmt.Errorf("в ответе нет ключа items")
}

var items []struct {
	Name       string `json:"name"`
	Type       string `json:"type"`
	Title      string `json:"title"`
	Filterable bool   `json:"filterable"`
	Sortable   bool   `json:"sortable"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.Name)
}
```

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