Получить набор дополнительных контентных блоков в деле
Scope: crm Права на выполнение: REST Приложение
Описание и параметры
Метод crm.activity.layout.blocks.get позволяет REST приложению получать установленный им же набор дополнительных контентных блоков в деле.
REST приложение может получить только тот набор дополнительных контентных блоков, который был установлен им же
Параметры
Обязательные параметры отмечены *
Параметртип |
Описание |
---|---|
entityTypeId*integer |
Идентификатор типа объекта CRM, к которому привязано дело |
entityId*integer |
Идентификатор объекта CRM, к которому привязано дело |
activityId*integer |
Идентификатор дела |
Примеры кода
Получить набор дополнительных контентных блоков в деле с id = 8
, привязанного к сделке с id = 4
:
- cURL (Webhook)
curl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"entityTypeId":2,"entityId":4,"activityId":8}' \ https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.layout.blocks.get
- cURL (OAuth)
curl -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ -d '{"entityTypeId":2,"entityId":4,"activityId":8,"auth":"**put_access_token_here**"}' \ https://**put_your_bitrix24_address**/rest/crm.activity.layout.blocks.get
- JS
BX24.callMethod( 'crm.activity.layout.blocks.get', { entityTypeId: 2 entityId: 4, activityId: 8, }, (result) => { if (result.error()) { console.error(result.error()); } else { console.info(result.data()); } }, );
- PHP
require_once('crest.php'); $result = CRest::call( 'crm.activity.layout.blocks.get', [ 'entityTypeId' => 2, 'entityId' => 4, 'activityId' => 8 ] ); echo '
'; print_r($result); echo '
';
Обработка ответа и ошибок
HTTP-статус: 200
Возвращает object
с ключом layout
, содержащим в себе RestAppLayoutDto.
{ "layout": { "blocks": { "block_1": { "type": "text", "properties": { "value": "Здравствуйте!\nМы начинаем.", "multiline": true, "bold": true, "color": "base_90" } }, "block_2": { "type": "largeText", "properties": { "value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания." } }, "block_3": { "type": "link", "properties": { "text": "Открыть сделку", "bold": true, "action": { "type": "redirect", "uri": "/crm/deal/details/123/" } } }, "block_4": { "type": "withTitle", "properties": { "title": "Заголовок", "block": { "type": "text", "properties": { "value": "Какое-то значение" } } } } } } }
Возможные коды ошибок
Код | Описание |
---|---|
ERROR_WRONG_CONTEXT | Вызов метода возможен только в контексте rest приложения |
OWNER_NOT_FOUND | Сущность, к которой привязано дело, не найдена |
NOT_FOUND | Дело не найдено |
ACCESS_DENIED | Доступ запрещен |
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Пользовательские комментарии
Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.Для этого нужно всего лишь авторизоваться на сайте
Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.
Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.