Сбросить параметры карточки элементов crm.item.details.configuration.reset

Название метода: crm.item.details.configuration.reset

Scope: crm

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

Любой пользователь имеет право сбросить свои личные настройки

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

Метод сбрасывает настройки карточки элемента до значений по умолчанию. Удаляет личные настройки карточки указанного пользователя или общие настройки, заданные для всех пользователей.

Примечание

Настройки карточки повторных лидов могут отличаться от настроек карточки простых лидов. Для переключения между настройками карточек лидов применяется параметр extras.leadCustomerType.
Настройки карточки элемента могут отличаться в зависимости от их воронки. Для переключения используется параметры
- extras.categoryId — для смарт-процессов
- extras.dealCategoryId — для сделок

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

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

Название `тип`	Описание
entityTypeId* `integer`	Идентификатор системного или пользовательского типа объектов CRM
userId `user`	Идентификатор пользователя, чью конфигурацию вы хотите сбросить. Если параметр не передан, то будет взят `userId` пользователя, вызывающего этот метод. Нужен только при запросе личных настроек
scope `string`	Область применения настроек. Допустимые значения: `'P'` — личные настройки `'C'` — общие настройки По умолчанию значение равно `'P'`
extras `object`	Дополнительные параметры. Возможные значения и их структура описана ниже

extras

Параметр в extras зависит от объекта CRM.

Объект CRM	Название	Описание
Смарт-процесс	`categoryId`	Идентификатор воронки смарт-процессов. Можно получить с помощью `crm.category.list`. Если не указано, то берется идентификатор воронки по умолчанию для данного смарт-процесса
Сделка	`dealCategoryId`	Идентификатор воронки сделок. Можно получить с помощью `crm.category.list`. Если не указан, то берется идентификатор воронки по умолчанию для сделок
Лид	`leadCustomerType`	Тип лидов. Возможные значения: `1` — простые лиды `2` — повторные лиды

Примеры кода

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

Сбросить общую конфигурацию для карточек сделок в воронке с id = 9 для пользователя с id = 1

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.reset

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"entityTypeId":2,"userId":1,"scope":"C","extras":{"dealCategoryId":9},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.reset

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.details.configuration.reset',
        		{
        			entityTypeId: 2,
        			userId: 1,
        			scope: "C",
        			extras: {
        				dealCategoryId: 9,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.details.configuration.reset',
                    [
                        'entityTypeId' => 2,
                        'userId'       => 1,
                        'scope'        => "C",
                        'extras'       => [
                            'dealCategoryId' => 9,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
                return;
            }
        
            echo 'Success: ' . print_r($result->data(), true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error resetting details configuration: ' . $e->getMessage();
        }

    BX24.callMethod(
                'crm.item.details.configuration.reset',
                {
                    entityTypeId: 2,
                    userId: 1,
                    scope: "C",
                    extras: {
                        dealCategoryId: 9,
                    },
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
        
                        return;
                    }
        
                    console.info(result.data());
                },
            );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.details.configuration.reset',
            [
                'entityTypeId' => 2,
                'userId' => 1,
                'scope' => 'C',
                'extras' => [
                    'dealCategoryId' => 9,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start": 1720687072.190654,
                "finish": 1720687072.586945,
                "duration": 0.39629101753234863,
                "processing": 0.057084083557128906,
                "date_start": "2024-07-11T10:37:52+02:00",
                "date_finish": "2024-07-11T10:37:52+02:00",
                "operating": 0
            }
        }

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

Название `тип`	Описание
result `boolean`	Корневой элемент ответа. Возвращает `true` в случае успешного сброса настроек
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error": "",
            "error_description": "Parameter 'entityTypeId' is not defined"
        }

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

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

Код	Описание	Значение
Пустое значение	Parameter 'entityTypeId' is not defined	Не передан обязательный параметр `entityTypeId`
Пустое значение	The entity type '`entityTypeName`' is not supported in current context.	Метод не поддерживает данный тип сущности
Пустое значение	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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Установить параметры карточки элементов

Установить общую карточку для всех пользователей

Сбросить параметры карточки элементов crm.item.details.configuration.reset

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

extrasextras

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

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

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

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

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

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

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