Обновить пользовательское поле task.item.userfield.update

Scope: task

Кто может выполнять метод: администратор

Метод task.item.userfield.update обновляет параметры пользовательского поля задачи.

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

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

Название
тип

Описание

ID*
integer

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

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

DATA*
object

Набор обновляемых параметров поля (подробное описание)

Параметр DATA

Название `тип`	Описание
XML_ID `string`	Внешний идентификатор
EDIT_FORM_LABEL `object`	Подпись в форме редактирования (подробное описание)
LABEL `string`	Название пользовательского поля
SORT `integer`	Сортировка
MULTIPLE `string`	Множественное значение. Возможные значения: `Y` — множественное `N` — единственное Применяется для типов `string`, `double`, `datetime`. Для типа `boolean` всегда используется `N`
MANDATORY `string`	Обязательное значение. Возможные значения: `Y` — обязательно `N` — не обязательное
SETTINGS `object`	Дополнительные настройки типа поля (подробное описание)

Параметр EDIT_FORM_LABEL

Название `тип`	Описание
ru `string`	Подпись на русском языке
en `string`	Подпись на английском языке

Параметр SETTINGS

Поля объекта SETTINGS зависят от типа USER_TYPE_ID.

string

double

datetime

boolean

Название `тип`	Описание
DEFAULT_VALUE `string`	Значение по умолчанию
ROWS `integer`	Количество строк в поле ввода

Название `тип`	Описание
DEFAULT_VALUE `double`	Значение по умолчанию

Название
тип

Описание

DEFAULT_VALUE

Значение по умолчанию. Описывается как объект с двумя параметрами:

TYPE string — режим заполнения значения по умолчанию
- NONE — значение по умолчанию не задается
- FIXED — используется значение из VALUE
- NOW — используется текущее время
VALUE datetime — значение для типа FIXED

DEFAULT_VALUE: {
            TYPE: 'NOW',
            VALUE: ''
        },

Название
тип

Описание

DEFAULT_VALUE
integer

Значение по умолчанию:

0 — нет
1 — да

DISPLAY
string

Вариант отображения значения:

CHECKBOX — флажок
RADIO — радиокнопки
DROPDOWN — выпадающий список

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "DATA": {
            "EDIT_FORM_LABEL": {
              "ru": "Описание запроса клиента",
              "en": "Description of client request"
            },
            "MANDATORY": "N"
          }
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/task.item.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
          "ID": 1325,
          "DATA": {
            "EDIT_FORM_LABEL": {
              "ru": "Описание запроса клиента",
              "en": "Description of client request"
            },
            "MANDATORY": "N"
          },
          "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/task.item.userfield.update

try
        {
            const response = await $b24.callMethod(
                'task.item.userfield.update',
                {
                    ID: 1325,
                    DATA: {
                        EDIT_FORM_LABEL: {
                            ru: 'Описание запроса клиента',
                            en: 'Description of client request'
                        },
                        MANDATORY: 'N'
                    }
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'task.item.userfield.update',
                    [
                        'ID' => 1325,
                        'DATA' => [
                            'EDIT_FORM_LABEL' => [
                                'ru' => 'Описание запроса клиента',
                                'en' => 'Description of client request'
                            ],
                            'MANDATORY' => 'N',
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }

BX24.callMethod(
            'task.item.userfield.update',
            {
                ID: 1325,
                DATA: {
                    EDIT_FORM_LABEL: {
                        ru: 'Описание запроса клиента',
                        en: 'Description of client request'
                    },
                    MANDATORY: 'N'
                }
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'task.item.userfield.update',
            [
                'ID' => 1325,
                'DATA' => [
                    'EDIT_FORM_LABEL' => [
                        'ru' => 'Описание запроса клиента',
                        'en' => 'Description of client request'
                    ],
                    'MANDATORY' => 'N',
                ]
            ]
        );
        
        print_r($result);

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1740000000.000000,
                "finish": 1740000000.100000,
                "duration": 0.100000,
                "processing": 0.080000,
                "date_start": "2025-02-20T10:00:00+03:00",
                "date_finish": "2025-02-20T10:00:00+03:00",
                "operating_reset_at": 1740003600,
                "operating": 0.080000
            }
        }

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

Название `тип`	Описание
result `boolean`	Возвращает `true`, если поле успешно обновлено
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

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

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

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

Статус	Код	Описание	Значение
`400`	`ERROR_CORE`	TASKS_ERROR_EXCEPTION_#0; Invalid arguments for Bitrix\Tasks\Integration\Rest\Task\UserField::update; 0/TE	Не переданы обязательные параметры `ID` и `DATA`
`400`	`ERROR_CORE`	ID is not defined or invalid	В параметр `ID` передано нечисловое значение или значение `<= 0`
`400`	`ERROR_NOT_FOUND`	The entity with ID '{ID}' is not found	Пользовательское поле с указанным `ID` не найдено
`400`	`ERROR_CORE`	Access denied	Недостаточно прав для изменения пользовательского поля

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

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

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

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

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

Обновить пользовательское поле task.item.userfield.update

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

Параметр DATAПараметр DATA

Параметр EDIT_FORM_LABELПараметр EDIT_FORM_LABEL

Параметр SETTINGSПараметр SETTINGS

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

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

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

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

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

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

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

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

Параметр DATA

Параметр EDIT_FORM_LABEL

Параметр SETTINGS

Примеры кода

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

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

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

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

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

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