Получить поле файлов задачи tasks.task.file.field.get

Scope: tasks

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

Метод tasks.task.file.field.get возвращает описание поля файлов задачи по имени.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

name*
string

Имя поля, описание которого нужно получить

select
array

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

Доступные поля:

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

Примеры кода

Как использовать примеры в документации

Вызов нового api отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/tasks.task.file.field.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"taskId","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.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"name":"taskId","select":["name","type","title","description","filterable","sortable","multiple"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/tasks.task.file.field.get

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try
        {
            const response = await $b24.callMethod(
                'tasks.task.file.field.get',
                {
                    name: 'taskId',
                    select: [
                        'name',
                        'type',
                        'title',
                        'description',
                        'filterable',
                        'sortable',
                        'multiple'
                    ]
                }
            );
        
            const result = response.getData().result;
            console.log('Field item:', result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'tasks.task.file.field.get',
                    [
                        'name' => 'taskId',
                        'select' => [
                            'name',
                            'type',
                            'title',
                            'description',
                            'filterable',
                            'sortable',
                            'multiple'
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

BX24.callMethod(
            'tasks.task.file.field.get',
            {
                name: 'taskId',
                select: [
                    'name',
                    'type',
                    'title',
                    'description',
                    'filterable',
                    'sortable',
                    'multiple'
                ]
            },
            function(result){
                console.info(result.data());
                console.log(result);
            }
        );

SDK пока не поддерживают в вызовах адрес /rest/api/. Используйте прямые HTTP-запросы, например, через curl, fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'tasks.task.file.field.get',
            [
                'name' => 'taskId',
                'select' => [
                    'name',
                    'type',
                    'title',
                    'description',
                    'filterable',
                    'sortable',
                    'multiple'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "item": {
                    "name": "taskId",
                    "type": "int",
                    "title": "taskId",
                    "description": null,
                    "filterable": false,
                    "sortable": false,
                    "multiple": false
                }
            },
            "time": {
                "start": 1773649754,
                "finish": 1773649754.213566,
                "duration": 0.21356606483459473,
                "processing": 0,
                "date_start": "2026-03-16T11:29:14+03:00",
                "date_finish": "2026-03-16T11:29:14+03:00",
                "operating_reset_at": 1773650354,
                "operating": 0
            }
        }

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

Название
тип

Описание

result
object

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

item
object

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

time
time

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

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

HTTP-статус: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Ошибка при валидации объекта запроса",
                "validation": [
                    {
                        "field": "name",
                        "message": "Обязательное поле `name` не указано"
                    }
                ]
            }
        }

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя и scope task

Ошибки нахождения данных

Код ошибки: BITRIX_REST_V3_REALISATION_EXCEPTION_FIELDNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

name

Поле #FIELD# не найдено

Укажите существующее имя поля

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

name

Обязательное поле name не указано

Передайте параметр name с существующим именем поля

Ошибки в параметре select

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select

Неизвестное поле #FIELD# для сущности DtoFieldDto

Передайте только поля из списка: name, type, title, description, validationRules, requiredGroups, filterable, sortable, editable, multiple, elementType

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Поле

Описание ошибки

Как исправить

select

Не удается распознать выражение select #SELECT#

Передайте select как массив строк, например ["name","type"]

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить список полей файлов задачи
Следующая
Получить список полей сообщения чата задачи