Изменить настраиваемое поле заданного шаблона реквизитов crm.requisite.preset.field.update

Scope: crm

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

Метод изменяет настраиваемое поле в шаблоне реквизитов.

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

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

Название
тип

Описание

id*
integer

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

Идентификаторы настраиваемых полей шаблона реквизитов можно получить с помощью метода crm.requisite.preset.field.list

preset*
object

Объект, содержащий значение идентификатора шаблона, в который добавляется настраиваемое поле (например, {"ID": 27}).

Идентификаторы шаблонов можно получить с помощью метода crm.requisite.preset.list

fields*
object

Объект с полями и их значениями, которые нужно изменить. Метод crm.requisite.preset.field.fields позволяет получить описание полей, которые можно менять.

API требует указать значение в поле FIELD_NAME. Если его не нужно менять, то можно указать текущее

Параметр fields

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

Название
тип

Описание

FIELD_NAME*
string

Название поля.

API требует указать значение в этом поле. Если его не нужно менять, то можно указать текущее

FIELD_TITLE
string

Альтернативное название поля для реквизита.

Альтернативное название отображается в различных формах для заполнения реквизитов. В зависимости от конкретной формы альтернативное название может использоваться или нет

SORT
integer

Сортировка. Порядок в списке полей шаблона

IN_SHORT_LIST
char

Показывать в кратком списке. Устаревшее поле, сейчас не используется. Оставлено для обратной совместимости. Может принимать значения Y или N

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":1,"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"Имя","IN_SHORT_LIST":"Y"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.requisite.preset.field.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"ID":1,"preset":{"ID":27},"fields":{"FIELD_NAME":"RQ_NAME","FIELD_TITLE":"Имя","IN_SHORT_LIST":"Y"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.requisite.preset.field.update
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.requisite.preset.field.update",
        		{
        			ID: 1,
        			preset:
        			{
        				"ID": 27
        			},
        			fields:
        			{
        				"FIELD_NAME": "RQ_NAME",
        				"FIELD_TITLE": "Имя",
        				"IN_SHORT_LIST": "Y",
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch(error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.requisite.preset.field.update',
                    [
                        'ID'     => 1,
                        'preset' => [
                            'ID' => 27,
                        ],
                        'fields' => [
                            'FIELD_NAME'    => 'RQ_NAME',
                            'FIELD_TITLE'   => 'Имя',
                            'IN_SHORT_LIST' => 'Y',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating preset field: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.requisite.preset.field.update",
            {
                ID: 1,          // Идентификатор настраиваемого поля, которое нужно изменить
                preset:
                {
                    "ID": 27    // Идентификатор шаблона реквизитов
                },
                fields:         // Значения полей, которые нужно изменить
                {
                    "FIELD_NAME": "RQ_NAME",    // API требует указать значение в этом поле. Если
                                                // значение менять не нужно, оставляем прежнее.
                    "FIELD_TITLE": "Имя",
                    "IN_SHORT_LIST": "Y",
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.requisite.preset.field.update',
            [
                'ID' => 1,
                'preset' => ['ID' => 27],
                'fields' => [
                    'FIELD_NAME' => 'RQ_NAME',
                    'FIELD_TITLE' => 'Имя',
                    'IN_SHORT_LIST' => 'Y',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1716898310.398361,
                "finish": 1716898310.936332,
                "duration": 0.537971019744873,
                "processing": 0.09376883506774902,
                "date_start": "2024-05-28T14:11:50+02:00",
                "date_finish": "2024-05-28T14:11:50+02:00",
                "operating": 0
            }
        }

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

Название
тип

Описание

result
boolean

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

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

time
time

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

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

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

{
            "error": "",
            "error_description": "The PresetField with ID '27' is not found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

The PresetField with ID '1' is not found

Поле с указанным идентификатором не найдено

The Preset with ID '27' is not found

Шаблон с указанным идентификатором не найден

ID is not defined or invalid

Идентификатор поля не указан или имеет недопустимое значение

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

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

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

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