Set a set of additional content blocks in the timeline record crm.timeline.layout.blocks.set
Scope:
crmWho can execute the method: administrator
The method crm.timeline.layout.blocks.set sets a set of additional content blocks for a timeline record.
Setting a new set of additional content blocks in a timeline record will erase the previously added set within the same application.
Setting a set of additional content blocks cannot be applied to timeline records related to:
- activities, for activities use the methods crm.activity.layout.blocks.*,
- timeline log records,
- deprecated timeline records.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object to which the timeline record is linked |
|
entityId* |
Identifier of the CRM object to which the timeline record is linked |
|
timelineId* |
Identifier of the timeline record |
|
layout* |
Object describing the set of additional content blocks |
Code Examples
In the timeline record with id = 8, linked to the deal with id = 4, we will set the following set of additional content blocks:
- Text
- Long multiline text
- Link
- Block with a title
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"timelineId":8,"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":"Title","block":{"type":"text","properties":{"value":"Some value"}}}}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.layout.blocks.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":2,"entityId":4,"timelineId":8,"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":"Title","block":{"type":"text","properties":{"value":"Some value"}}}}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.layout.blocks.set
try
{
const response = await $b24.callMethod(
'crm.timeline.layout.blocks.set',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record linked to this deal
layout: layout, // Object describing the set of additional content blocks
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'crm.timeline.layout.blocks.set',
[
'entityTypeId' => 2, // Deal
'entityId' => 4, // Deal ID
'timelineId' => 8, // ID of the timeline record linked to this 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' => "Title",
'block' => [
'type' => "text",
'properties' => [
'value' => "Some value"
]
]
]
]
]
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting timeline layout blocks: ' . $e->getMessage();
}
const 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: "Title",
block: {
type: "text",
properties: {
value: "Some value"
}
}
}
}
}
};
BX24.callMethod(
'crm.timeline.layout.blocks.set',
{
entityTypeId: 2, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record linked to this deal
layout: layout, // Object describing the set of additional content blocks
},
(result) => {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
},
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.layout.blocks.set',
[
'entityTypeId' => 2,
'entityId' => 4,
'timelineId' => 8,
'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' => "Title",
'block' => [
'type' => "text",
'properties' => [
'value' => "Some value"
]
]
]
]
]
]
]
);
echo '';
print_r($result);
echo '';
Appearance
If the timeline record contains more than one set of additional content blocks, they will be displayed in the order they were added.
In the HTML layout, it is explicitly highlighted with data attributes which application added the set of additional content blocks:
data-app-name: application name,data-rest-client-id: application identifier.
Response Handling
HTTP status: 200
Returns { success: true } in case of successful recording of the set of additional content blocks, otherwise null.
{
"success": true
}
Error Handling
HTTP status: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "Method call is only possible in the context of a REST application"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Method call is only possible in the context of a REST application |
|
|
The element to which the timeline record is linked was not found |
|
|
Timeline record not found |
|
|
Access denied |
|
|
The type of timeline record is not suitable for adding a set of additional content blocks |
|
|
The |
The method also returns errors related to incorrect structure of the content block set. Details can be found in the error message.
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Additional Content Blocks
- Get a set of additional content blocks for the timeline record crm.timeline.layout.blocks.get
- Delete a set of additional content blocks for the timeline record crm.timeline.layout.blocks.delete
- Example Application with Additional Content Blocks