Изменить пользовательское поле реквизита crm.requisite.userfield.update

Scope: crm

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

Метод изменяет существующее пользовательское поле реквизита.

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

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

Название `тип`	Описание
id* `integer`	Идентификатор пользовательского поля. Можно получить с помощью метода crm.requisite.userfield.list
fields* `object`	Набор полей — объект вида `{"поле": "значение"[, ...]}`, значения которых нужно изменить

Параметр fields

Название `тип`	Описание
XML_ID `string`	Внешний ключ. Используется для операций обмена. Идентификатор объекта внешней информационной базы. Назначение поля может меняться конечным разработчиком
SORT `integer`	Сортировка
MULTIPLE `char`	Признак множественности. Возможные значения: `Y` — да `N` — нет
MANDATORY `char`	Признак обязательности. Возможные значения: `Y` — да `N` — нет
SHOW_FILTER `char`	Показывать ли в фильтре списка. Возможные значения: `N` — не показывать `I` — точное совпадение `E` — маска `S` — подстрока
SHOW_IN_LIST `char`	Показывать ли в списке. Возможные значения: `Y` — да `N` — нет
EDIT_IN_LIST `char`	Разрешать ли редактирование пользователем. Возможные значения: `Y` — да `N` — нет
IS_SEARCHABLE `char`	Участвуют ли значения поля в поиске. Возможные значения: `Y` — да `N` — нет
EDIT_FORM_LABEL `string`	Подпись в форме редактирования
LIST_COLUMN_LABEL `string`	Заголовок в списке
LIST_FILTER_LABEL `string`	Подпись фильтра в списке
ERROR_MESSAGE `string`	Сообщение об ошибке
HELP_MESSAGE `string`	Помощь
LIST `uf_enum_element`	Элементы списка. Для получения подробной информации смотрите раздел Получить описание полей для пользовательского поля типа «enumeration» (список) crm.userfield.enumeration.fields
SETTINGS `object`	Дополнительные настройки (зависят от типа). Для получения подробной информации смотрите раздел Получить описание полей настроек для типа пользовательского поля crm.userfield.settings.fields

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Категория","LIST_COLUMN_LABEL":"Категория","LIST_FILTER_LABEL":"Категория"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.userfield.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":235,"fields":{"EDIT_FORM_LABEL":"Категория","LIST_COLUMN_LABEL":"Категория","LIST_FILTER_LABEL":"Категория"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.userfield.update

try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.userfield.update",
        		{
        			id: 235,
        			fields:
        			{
        				"EDIT_FORM_LABEL": title,
        				"LIST_COLUMN_LABEL": title,
        				"LIST_FILTER_LABEL": title
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

$title = "Категория";
        
        try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.userfield.update',
                    [
                        'id' => 235,
                        'fields' => [
                            'EDIT_FORM_LABEL'   => $title,
                            'LIST_COLUMN_LABEL' => $title,
                            'LIST_FILTER_LABEL' => $title
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating user field: ' . $e->getMessage();
        }

const title = "Категория";
        BX24.callMethod(
            "crm.requisite.userfield.update",
            {
                id: 235,
                fields:
                {
                    "EDIT_FORM_LABEL": title,
                    "LIST_COLUMN_LABEL": title,
                    "LIST_FILTER_LABEL": title
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $title = "Категория";
        
        $result = CRest::call(
            'crm.requisite.userfield.update',
            [
                'id' => 235,
                'fields' =>
                [
                    'EDIT_FORM_LABEL' => $title,
                    'LIST_COLUMN_LABEL' => $title,
                    'LIST_FILTER_LABEL' => $title
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1717769551.504986,
                "finish": 1717769551.817433,
                "duration": 0.31244707107543945,
                "processing": 0.04784202575683594,
                "date_start": "2024-06-07T16:12:31+02:00",
                "date_finish": "2024-06-07T16:12:31+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

Результат изменения пользовательского поля реквизита:

true — изменено
false — не изменено

time
time

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

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

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

{
            "error": "",
            "error_description": "The entity with ID '235' is not found."
        }

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

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

Код	Текст ошибки	Описание
Пустая строка	`Operation is not allowed. Entity ID is not defined`	Пользовательское поле с указанным идентификатором не найдено
Пустая строка	`The entity with ID '235' is not found`	Пользовательское поле с указанным идентификатором не найдено
Пустая строка	`ID is not defined or invalid`	Идентификатор пользовательского поля не указан или имеет недопустимое значение
Пустая строка	`Access denied`	Недостаточно прав доступа для изменения пользовательского поля
`ERROR_CORE`	`Fail to update user field`	Не удалось изменить пользовательское поле
`ERROR_CORE`	`Fail to save enumumeration field values`	Не удалось сохранить значения пользовательского поля списочного типа (например, когда произошло дублирование внешнего ключа одного из значений)

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

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

Изменить пользовательское поле реквизита crm.requisite.userfield.update

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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