метод REST scope: placement

placement.list

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

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

Описание

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

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

Параметры

SCOPE string необязательный

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

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

FULL boolean необязательный

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

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

Если параметр передан как true, метод возвращает точки встраивания для всех 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"

Ответ

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"
}
Код Описание Значение
403 WRONG_AUTH_TYPE Current authorization type is denied for this method Application context required

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.