Получить пользовательское поле задачи по идентификатору task.item.userfield.get

Scope: task

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

Метод task.item.userfield.get получает описание пользовательского поля задачи по идентификатору.

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

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

Название
тип

Описание

ID*
integer

Идентификатор пользовательского поля.

Идентификатор пользовательского поля задачи можно получить при создании поля или методом получения списка полей

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.get

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.get

try
        {
            const response = await $b24.callMethod(
                'task.item.userfield.get',
                {
                    ID: 1325
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.userfield.get',
                    [
                        'ID' => 1325
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'task.item.userfield.get',
            {
                ID: 1325
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.item.userfield.get',
            [
                'ID' => 1325
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": {
                "ID": "1325",
                "ENTITY_ID": "TASKS_TASK",
                "FIELD_NAME": "UF_TASK_CLIENT_REQUEST",
                "USER_TYPE_ID": "string",
                "XML_ID": "UF_TASK_CLIENT_REQUEST",
                "SORT": "220",
                "MULTIPLE": "N",
                "MANDATORY": "N",
                "SHOW_FILTER": "N",
                "SHOW_IN_LIST": "Y",
                "EDIT_IN_LIST": "Y",
                "IS_SEARCHABLE": "N",
                "SETTINGS": {
                    "SIZE": 20,
                    "ROWS": 10,
                    "REGEXP": "",
                    "MIN_LENGTH": 0,
                    "MAX_LENGTH": 0,
                    "DEFAULT_VALUE": "Уточнить цель и ожидаемый результат"
                },
                "EDIT_FORM_LABEL": {
                    "ar": "",
                    "br": "",
                    "de": "",
                    "en": "Description of client request",
                    ...,
                    "ru": "Описание запроса клиента",
                    ...
                },
                "LIST_COLUMN_LABEL": {
                    "ar": "Запрос клиента",
                    "br": "Запрос клиента",
                    ...
                },
                "LIST_FILTER_LABEL": {
                    "ar": "Запрос клиента",
                    "br": "Запрос клиента",
                    ...
                },
                "ERROR_MESSAGE": {
                    "ar": "Запрос клиента",
                    "br": "Запрос клиента",
                    ...
                },
                "HELP_MESSAGE": {
                    "ar": "Запрос клиента",
                    "br": "Запрос клиента",
                    ...
                }
            },
            "total": 0,
            "time": {
                "start": 1772718119,
                "finish": 1772718119.677154,
                "duration": 0.6771540641784668,
                "processing": 0,
                "date_start": "2026-03-05T16:41:59+03:00",
                "date_finish": "2026-03-05T16:41:59+03:00",
                "operating_reset_at": 1772718719,
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `object`	Объект пользовательского поля (подробное описание)
total `integer`	Сейчас возвращает `0`
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
ID `integer`	Идентификатор пользовательского поля
ENTITY_ID `string`	Код объекта, к которому привязано поле
FIELD_NAME `string`	Код пользовательского поля
USER_TYPE_ID `string`	Тип данных
XML_ID `string`	Внешний идентификатор
SORT `integer`	Порядок сортировки
MULTIPLE `char`	Признак множественного значения. Возможные значения: `Y` — множественное `N` — единственное
MANDATORY `char`	Признак обязательного поля. Возможные значения: `Y` — обязательное `N` — не обязательное
SHOW_FILTER `char`	Показ в фильтре списка
SHOW_IN_LIST `char`	Показ в списке
EDIT_IN_LIST `char`	Разрешено редактирование в списке
IS_SEARCHABLE `char`	Значение участвует в поиске
EDIT_FORM_LABEL `object`	Локализованные подписи в форме редактирования
LIST_COLUMN_LABEL `object`	Локализованные заголовки колонки в списке
LIST_FILTER_LABEL `object`	Локализованные подписи в фильтре списка
ERROR_MESSAGE `object`	Локализованные тексты ошибок валидации
HELP_MESSAGE `object`	Локализованные подсказки для поля
SETTINGS `object`	Дополнительные настройки поля (подробное описание)

Объект SETTINGS

Название `тип`	Описание
SIZE `integer`	Ширина поля ввода
ROWS `integer`	Количество строк в поле ввода
REGEXP `string`	Регулярное выражение для проверки значения
MIN_LENGTH `integer`	Минимальная длина значения
MAX_LENGTH `integer`	Максимальная длина значения
DEFAULT_VALUE `string`	Значение по умолчанию

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

HTTP-статус: 400

{
            "error": "ERROR_CORE",
            "error_description": "ID is not defined or invalid."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Статус	Код	Описание	Значение
`400`	`ERROR_CORE`	No parameters found	Не передан обязательный параметр `ID`
`400`	`ERROR_CORE`	ID is not defined or invalid	В параметре `ID` передано нечисловое значение или значение `<= 0`
`400`	`ERROR_NOT_FOUND`	The entity with ID '{ID}' is not found	Пользовательское поле с указанным `ID` не найдено

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

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

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

Обновить пользовательское поле

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

Получить пользовательское поле задачи по идентификатору task.item.userfield.get

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

Примеры кодаПримеры кода

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

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

Объект resultОбъект result

Объект SETTINGSОбъект SETTINGS

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

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

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

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