crm.activity.layout.blocks.set — метод REST API Битрикс24

Описание

Метод crm.activity.layout.blocks.set устанавливает набор дополнительных контентных блоков для дела.

Установка нового набора дополнительных контентных блоков в дело будет стирать ранее добавленный набор в рамках одного приложения.

Установка набора дополнительных контентных блоков не может быть применена к:
- конфигурируемому делу,
- делу, тип которого является устаревшим.

Параметры

entityTypeId integer обязательный

Идентификатор типа объекта CRM, к которому привязано дело

entityId integer обязательный

Идентификатор объекта CRM, к которому привязано дело

activityId integer обязательный

Идентификатор дела

layout RestAppLayoutDto обязательный

Объект, описывающий набор дополнительных контентных блоков

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"activityId":8,"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":"Какое-то значение"}}}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.layout.blocks.set

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"activityId":8,"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":"Какое-то значение"}}}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.layout.blocks.set

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type SetLayoutBlocksResult = {
  success: boolean
}

try {
  const response = await $b24.actions.v2.call.make<SetLayoutBlocksResult>({
    method: 'crm.activity.layout.blocks.set',
    params: {
      entityTypeId: 2, // Deal
      entityId: 4,     // Deal ID
      activityId: 8,   // Activity ID linked to the deal
      layout: {
        blocks: {
          block_1: {
            type: 'text',
            properties: {
              value: 'Hello!\nWe are starting.',
              multiline: true,
              bold: true,
              color: 'base_90',
            },
          },
          block_2: {
            type: 'largeText',
            properties: {
              value: 'Hello!\nWe are starting.\nWe are continuing.\nWe are still working on this.\nWe are continuing.\nWe are close to the result.\nGoodbye.',
            },
          },
          block_3: {
            type: 'link',
            properties: {
              text: 'Open deal',
              bold: true,
              action: {
                type: 'redirect',
                uri: '/crm/deal/details/123/',
              },
            },
          },
          block_4: {
            type: 'withTitle',
            properties: {
              title: 'Header',
              block: {
                type: 'text',
                properties: {
                  value: 'Some value',
                },
              },
            },
          },
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Layout blocks set successfully:', result.success)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function setActivityLayoutBlocks() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'crm.activity.layout.blocks.set',
        params: {
          entityTypeId: 2, // Deal
          entityId: 4,     // Deal ID
          activityId: 8,   // Activity ID linked to the deal
          layout: {
            blocks: {
              block_1: {
                type: 'text',
                properties: {
                  value: 'Hello!\nWe are starting.',
                  multiline: true,
                  bold: true,
                  color: 'base_90',
                },
              },
              block_2: {
                type: 'largeText',
                properties: {
                  value: 'Hello!\nWe are starting.\nWe are continuing.\nWe are still working on this.\nWe are continuing.\nWe are close to the result.\nGoodbye.',
                },
              },
              block_3: {
                type: 'link',
                properties: {
                  text: 'Open deal',
                  bold: true,
                  action: {
                    type: 'redirect',
                    uri: '/crm/deal/details/123/',
                  },
                },
              },
              block_4: {
                type: 'withTitle',
                properties: {
                  title: 'Header',
                  block: {
                    type: 'text',
                    properties: {
                      value: 'Some value',
                    },
                  },
                },
              },
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Layout blocks set successfully:', result.success)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', setActivityLayoutBlocks)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
    bitrix_response = client.crm.activity.layout.blocks.set(entity_type_id=2, entity_id=101, activity_id=999, layout={
        "blocks": {
            "summary": {
                "type": "text",
                "properties": {
                    "value": "Proposal is ready",
                    "multiline": True,
                    "bold": True,
                    "color": "base_90",
                },
            },
            "dealLink": {
                "type": "link",
                "properties": {
                    "text": "Open deal",
                    "bold": True,
                    "action": {
                        "type": "redirect",
                        "uri": "/crm/deal/details/101/",
                    },
                },
            },
            "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": "Какое-то значение",
                        },
                    },
                },
            },
        },
    }).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print('Ошибка Bitrix API', f'error: {error.error}', f'error_description: {error.error_description}', sep='\n')
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'crm.activity.layout.blocks.set',
            [
                'entityTypeId' => 2, // Сделка
                'entityId'     => 4, // ID Сделки
                'activityId'   => 8, // ID Дела привязанного к данной сделке
                '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' => "Какое-то значение",
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error setting activity layout blocks: ' . $e->getMessage();
}

const 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: "Какое-то значение"
                    }
                }
            }
        }
    }
};
BX24.callMethod(
    'crm.activity.layout.blocks.set',
    {
        entityTypeId: 2, // Сделка
        entityId: 4,     // ID Сделки
        activityId: 8,   // ID Дела привязанного к данной сделке
        layout: layout,  // Объект, описывающий набор дополнительных контентных блоков
    },
    (result) => {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.info(result.data());
        }
    },
);

require_once('crest.php');
$result = CRest::call(
    'crm.activity.layout.blocks.set',
    [
        'entityTypeId' => 2,
        'entityId' => 4,
        'activityId' => 8,
        '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' => "Какое-то значение"
                            ]
                        ]
                    ]
                ]
            ]
        ]
    ]
);
echo '';
print_r($result);
echo '';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.layout.blocks.set", b24.Params{
	"entityTypeId": 2,
	"entityId":     4,
	"activityId":   8,
	"layout": b24.Params{
		"blocks": b24.Params{
			"block_1": b24.Params{
				"type": "text",
				"properties": b24.Params{
					"value":     "Здравствуйте!\nМы начинаем.",
					"multiline": true,
					"bold":      true,
					"color":     "base_90",
				},
			},
			"block_2": b24.Params{
				"type": "largeText",
				"properties": b24.Params{
					"value": "Здравствуйте!\nМы начинаем.\nМы продолжаем.\nМы все еще работаем над этим.\nМы продолжаем.\nМы близки к результату.\nДо свидания.",
				},
			},
			"block_3": b24.Params{
				"type": "link",
				"properties": b24.Params{
					"text": "Открыть сделку",
					"bold": true,
					"action": b24.Params{
						"type": "redirect",
						"uri":  "/crm/deal/details/123/",
					},
				},
			},
			"block_4": b24.Params{
				"type": "withTitle",
				"properties": b24.Params{
					"title": "Заголовок",
					"block": b24.Params{
						"type": "text",
						"properties": b24.Params{
							"value": "Какое-то значение",
						},
					},
				},
			},
		},
	},
})
if err != nil {
	return fmt.Errorf("crm.activity.layout.blocks.set: %w", err)
}

// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)

Ответ

HTTP-статус: 200

{
    "success": true
}

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

HTTP-статус: 400

{
    "error": "ERROR_WRONG_CONTEXT",
    "error_description": "Вызов метода возможен только в контексте rest приложения"
}

Код	Описание	Значение
`ERROR_WRONG_CONTEXT`	Вызов метода возможен только в контексте rest приложения
`OWNER_NOT_FOUND`	Элемент, к которому привязано дело, не найден
`NOT_FOUND`	Дело не найдено
`ACCESS_DENIED`	Доступ запрещен
`UNSUITABLE_ACTIVITY_TYPE_ERROR`	Тип данного дела не подходит для добавления набора дополнительных контентных блоков
`FIELD_IS_REQUIRED`	Поле `blocks` в `RestAppLayoutDto` должно быть заполнено.