crm.activity.layout.blocks.get
Получить набор дополнительных контентных блоков в деле
Описание
Метод crm.activity.layout.blocks.get получает набор дополнительных контентных блоков для дела.
В рамках приложения можно получить только тот набор дополнительных контентных блоков, который был установлен через это приложение.
Параметры
entityTypeId
integer
обязательный
Идентификатор типа объекта CRM, к которому привязано дело
entityId
integer
обязательный
Идентификатор объекта CRM, к которому привязано дело
activityId
integer
обязательный
Идентификатор дела
Примеры запроса
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 -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
// 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 LayoutBlocksGetResult = {
layout: {
blocks: Record<string, {
type: string
properties: Record<string, unknown>
}>
}
}
try {
const response = await $b24.actions.v2.call.make<LayoutBlocksGetResult>({
method: 'crm.activity.layout.blocks.get',
params: {
entityTypeId: 2,
entityId: 4,
activityId: 8,
},
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:', result.layout.blocks)
}
} 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 getLayoutBlocks() {
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.get',
params: {
entityTypeId: 2,
entityId: 4,
activityId: 8,
},
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:', result.layout.blocks)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLayoutBlocks)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.layout.blocks.get(
entity_type_id=2,
entity_id=101,
activity_id=999,
).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.get',
[
'entityTypeId' => 2,
'entityId' => 4,
'activityId' => 8,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Info: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting activity layout blocks: ' . $e->getMessage();
}
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());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.layout.blocks.get',
[
'entityTypeId' => 2,
'entityId' => 4,
'activityId' => 8
]
);
echo '';
print_r($result);
echo '';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.layout.blocks.get", b24.Params{
"entityTypeId": 2,
"entityId": 4,
"activityId": 8,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.activity.layout.blocks.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"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_WRONG_CONTEXT |
Вызов метода возможен только в контексте rest приложения | |
OWNER_NOT_FOUND |
Элемент, к которому привязано дело, не найден | |
NOT_FOUND |
Дело не найдено | |
ACCESS_DENIED |
Доступ запрещен |

