Получить список доступных приложению мест встраивания placement.list

Scope: placement

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

Метод placement.list возвращает список доступных приложению мест встраивания.

Метод работает только в контексте приложения.

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

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

Название
тип

Описание

SCOPE
string

Ограничивает список мест встраивания одним scope приложения.

Если параметр передан и не пустой, метод возвращает места встраивания только для указанного scope

FULL
boolean

Флаг получения полного списка мест встраивания.

Если параметр не передан или передан как false, метод возвращает места встраивания для scope текущего приложения и глобальные места встраивания.

Если параметр передан как true, метод возвращает места встраивания для всех scope сервиса.

Параметр учитывается, только если не передан SCOPE

Примеры кода

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

Пример получения списка мест встраивания, доступных приложению, где:

  • SCOPE — scope приложения, для которого нужно получить места встраивания
curl -X POST \
          -H "Content-Type: application/json" \
          -d '{
            "SCOPE": "crm",
            "auth": "**put_access_token_here**"
          }' \
          "https://**put.your-domain-here**/rest/placement.list.json"
        
try
        {
        	const response = await $b24.callMethod(
        		'placement.list',
        		{
        			SCOPE: 'crm'
        		}
        	);
        
        	const result = response.getData().result;
        	console.info(result);
        }
        catch (error)
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.list',
                    [
                        'SCOPE' => 'crm',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting placement list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'placement.list',
            {
                SCOPE: 'crm'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error());
                }
                else
                {
                    console.info(result.data());
                }
            }
        );
        
$result = CRest::call(
            'placement.list',
            [
                'SCOPE' => 'crm',
            ]
        );
        
        echo '<pre>';
        print_r($result);
        echo '</pre>';

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

HTTP-статус: 200

{
            "result": [
                "CRM_DEAL_LIST_TOOLBAR",
                "CRM_LEAD_LIST_TOOLBAR",
                "CRM_CONTACT_LIST_TOOLBAR",
                "CRM_COMPANY_LIST_TOOLBAR",
                "CRM_INVOICE_LIST_TOOLBAR",
                "CRM_QUOTE_LIST_TOOLBAR",
                "CRM_ORDER_LIST_TOOLBAR",
                "CRM_DYNAMIC_136_LIST_TOOLBAR",
                "CRM_DYNAMIC_1038_LIST_TOOLBAR",
                "CRM_SMART_INVOICE_LIST_TOOLBAR",
                "CRM_DEAL_DETAIL_TOOLBAR",
                "CRM_LEAD_DETAIL_TOOLBAR",
                "CRM_CONTACT_DETAIL_TOOLBAR",
                "CRM_COMPANY_DETAIL_TOOLBAR",
                "CRM_INVOICE_DETAIL_TOOLBAR",
                "CRM_QUOTE_DETAIL_TOOLBAR",
                "CRM_DYNAMIC_136_DETAIL_TOOLBAR",
                "CRM_DYNAMIC_1038_DETAIL_TOOLBAR",
                "CRM_SMART_INVOICE_DETAIL_TOOLBAR",
                "CRM_DEAL_ACTIVITY_TIMELINE_MENU",
                "CRM_LEAD_ACTIVITY_TIMELINE_MENU",
                "CRM_QUOTE_ACTIVITY_TIMELINE_MENU"
            ],
            "time": {
                "start": 1712132792.910734,
                "finish": 1712132793.530359,
                "duration": 0.6196250915527344,
                "processing": 0.032338857650756836,
                "date_start": "2024-04-03T10:26:32+02:00",
                "date_finish": "2024-04-03T10:26:33+02:00",
                "operating_reset_at": 1705765533,
                "operating": 3.3076241016387939
            }
        }

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

Название
тип

Описание

result
string[]

Список кодов мест встраивания, доступных приложению.

Каждый элемент массива — строковый код места встраивания

time
time

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

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

HTTP-статус: 403

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Current authorization type is denied for this method Application context required"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

403

WRONG_AUTH_TYPE

Current authorization type is denied for this method Application context required

Вызов метода не из контекста приложения

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

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

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

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

Предыдущая
Получить список зарегистрированных виджетов
Следующая
Отменить регистрацию виджета