Получить параметры карточки элементов crm.item.details.configuration.get

Scope: crm

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

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

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

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

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

extrasextras

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

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

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

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

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   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.get
           

   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.get
           

       BX24.callMethod(
                   'crm.item.details.configuration.get',
                   {
                       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.get',
               [
                   'entityTypeId' => 2,
                   'userId' => 1,
                   'scope' => "C",
                   'extras' => [
                       'dealCategoryId' => 9,
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

2. Получить личную конфигурацию карточки элементов смарт-процесса с entityTypeId = 1032 в воронке с id = 5

   cURL (Webhook)

   cURL (OAuth)

   JS

   PHP

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"entityTypeId":1032,"extras":{"categoryId":5}}' \
           https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.details.configuration.get
           

   curl -X POST \
           -H "Content-Type: application/json" \
           -H "Accept: application/json" \
           -d '{"entityTypeId":1032,"extras":{"categoryId":5},"auth":"**put_access_token_here**"}' \
           https://**put_your_bitrix24_address**/rest/crm.item.details.configuration.get
           

       BX24.callMethod(
                   'crm.item.details.configuration.get',
                   {
                       entityTypeId: 1032,
                       extras: {
                           categoryId: 5,
                       },
                   },
                   (result) => {
                       if (result.error())
                       {
                           console.error(result.error());
           
                           return;
                       }
           
                       console.info(result.data());
                   },
               );
           

   require_once('crest.php');
           
           $result = CRest::call(
               'crm.item.details.configuration.get',
               [
                   'entityTypeId' => 1032,
                   'extras' => [
                       'categoryId' => 5,
                   ]
               ]
           );
           
           echo '<PRE>';
           print_r($result);
           echo '</PRE>';
           

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

HTTP-статус: 200

{
            "result": [
                {
                    "name": "main",
                    "title": "О сделке",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TITLE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "STAGE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPPORTUNITY_WITH_CURRENCY",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CLOSEDATE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "CLIENT",
                            "optionFlags": "1",
                            "options": {
                                "defaultCountry": "RU"
                            }
                        },
                        {
                            "name": "UF_CRM_1686898039656",
                            "optionFlags": "1"
                        }
                    ]
                },
                {
                    "name": "additional",
                    "title": "Дополнительно",
                    "type": "section",
                    "elements": [
                        {
                            "name": "TYPE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "SOURCE_DESCRIPTION",
                            "optionFlags": "0"
                        },
                        {
                            "name": "BEGINDATE",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OPENED",
                            "optionFlags": "0"
                        },
                        {
                            "name": "ASSIGNED_BY_ID",
                            "optionFlags": "0"
                        },
                        {
                            "name": "OBSERVER",
                            "optionFlags": "0"
                        },
                        {
                            "name": "COMMENTS",
                            "optionFlags": "0"
                        },
                        {
                            "name": "UTM",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "products",
                    "title": "Товары",
                    "type": "section",
                    "elements": [
                        {
                            "name": "PRODUCT_ROW_SUMMARY",
                            "optionFlags": "0"
                        }
                    ]
                },
                {
                    "name": "recurring",
                    "title": "Регулярная сделка",
                    "type": "section",
                    "elements": [
                        {
                            "name": "RECURRING",
                            "optionFlags": "0"
                        }
                    ]
                }
            ],
            "time": {
                "start": 1720624891.017344,
                "finish": 1720624891.405621,
                "duration": 0.3882770538330078,
                "processing": 0.02097320556640625,
                "date_start": "2024-07-10T17:21:31+02:00",
                "date_finish": "2024-07-10T17:21:31+02:00",
                "operating": 0
            }
        }
        

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

sectionsection

Описывает отдельно взятый раздел с полями внутри карточки элемента

section_elementsection_element

Конфигурация отдельно взятого поля внутри раздела

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

HTTP-статус: 400

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

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

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

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

Описанные ниже ошибки могут возникнуть при вызове любого метода

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

• Настройка разделов в карточке элементов
• Установить параметры карточки элементов crm.item.details.configuration.set
• Сбросить параметры карточки элементов crm.item.details.configuration.reset
• Установить общую карточку для всех пользователей crm.item.details.configuration.forceCommonScopeForAll