метод REST scope: tasks

tasks.task.file.field.list

Получить список полей файлов задачи

Кто может выполнять: любой пользователь

Описание

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

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

Параметры

select array необязательный

Список полей описания, которые нужно вернуть в ответе.

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

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

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

Ответ

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "name": "taskId",
                "type": "int",
                "title": "taskId",
                "description": null,
                "filterable": false,
                "sortable": false,
                "multiple": false
            },
            {
                "name": "fileIds",
                "type": "array",
                "title": "fileIds",
                "description": null,
                "filterable": false,
                "sortable": false,
                "multiple": false
            }
        ]
    },
    "time": {
        "start": 1773650829,
        "finish": 1773650829.321994,
        "duration": 0.3219940662384033,
        "processing": 0,
        "date_start": "2026-03-16T11:47:09+03:00",
        "date_finish": "2026-03-16T11:47:09+03:00",
        "operating_reset_at": 1773651429,
        "operating": 0
    }
}

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

result object

Объект с данными ответа

items array

Массив объектов с описанием полей. Структура ответа зависит от select

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
        "message": "Неизвестное поле `unknownField` для сущности `DtoFieldDto`"
    }
}
Код Описание Значение
Поле Описание ошибки Как исправить
Доступ запрещен Проверьте права пользователя и scope task

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.