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

Описание и параметры

Метод crm.timeline.layout.blocks.get позволяет REST приложению получать установленный им же набор дополнительных контентных блоков для записи таймлайна.

REST приложение может получить только тот набор дополнительных контентных блоков, который был установлен им же.

Параметры

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

Примеры кода

Получить набор дополнительных контентных блоков для записи таймлайна с id = 8, привязанного к сделке с id = 4:

• cURL (Webhook)

  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 (OAuth)

  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

• JS

  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());
          }
      },
  );

• PHP

  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": "Какое-то значение"
						}
					}
				}
			}
		}
	}
}

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