Получить набор дополнительных контентных блоков для записи таймлайна crm.timeline.layout.blocks.get
Scope:
crmКто может выполнять метод: администратор
Метод crm.timeline.layout.blocks.get получает набор дополнительных контентных блоков для записи таймлайна.
В рамках приложения можно получить только тот набор дополнительных контентных блоков, который был установлен через это приложение.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
entityTypeId* |
Идентификатор типа объекта CRM, к которому привязана запись таймлайна |
|
entityId* |
Идентификатор объекта CRM, к которой привязана запись таймлайна |
|
timelineId* |
Идентификатор записи таймлайна |
Примеры кода
Получить набор дополнительных контентных блоков для записи таймлайна с id = 8, привязанного к сделке с id = 4:
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"timelineId":8}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.layout.blocks.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"timelineId":8,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.layout.blocks.get
try
{
const response = await $b24.callMethod(
'crm.timeline.layout.blocks.get',
{
entityTypeId: 2, // Сделка
entityId: 4, // ID Сделки
timelineId: 8, // ID Записи таймлайна привязанного к данной сделке
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.timeline.layout.blocks.get',
[
'entityTypeId' => 2, // Сделка
'entityId' => 4, // ID Сделки
'timelineId' => 8, // ID Записи таймлайна привязанного к данной сделке
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting timeline layout blocks: ' . $e->getMessage();
}
BX24.callMethod(
'crm.timeline.layout.blocks.get',
{
entityTypeId: 2, // Сделка
entityId: 4, // ID Сделки
timelineId: 8, // ID Записи таймлайна привязанного к данной сделке
},
(result) => {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.layout.blocks.get',
[
'entityTypeId' => 2,
'entityId' => 4,
'timelineId' => 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": "Какое-то значение"
}
}
}
}
}
}
}
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "Вызов метода возможен только в контексте rest приложения"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Вызов метода возможен только в контексте rest приложения |
|
|
Элемент, к которому привязана запись таймлайна, не найден |
|
|
Запись таймлайна не найдена |
|
|
Доступ запрещен |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Дополнительные контентные блоки
- Установить набор дополнительных контентных блоков в запись таймлайна crm.timeline.layout.blocks.set
- Удалить набор дополнительных контентных блоков для записи таймлайна crm.timeline.layout.blocks.delete
- Пример приложения с дополнительными контентными блоками