Get a set of additional content blocks for the timeline record crm.timeline.layout.blocks.get
Scope:
crmWho can execute the method: administrator
The method crm.timeline.layout.blocks.get retrieves a set of additional content blocks for a timeline record.
Within the application, you can only obtain the set of additional content blocks that has been installed through this application.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
entityTypeId* |
Identifier of the CRM object type 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 |
Code Examples
Retrieve a set of additional content blocks for the timeline record with id = 8, linked to the deal with id = 4:
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}' \
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, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record linked to this deal
}
);
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, // Deal
'entityId' => 4, // Deal ID
'timelineId' => 8, // ID of the timeline record linked to this deal
]
);
$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, // Deal
entityId: 4, // Deal ID
timelineId: 8, // ID of the timeline record linked to this deal
},
(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 '';
Response Handling
HTTP status: 200
Returns an object with the key layout, containing RestAppLayoutDto.
{
"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"
}
}
}
}
}
}
}
Error Handling
HTTP status: 400
{
"error": "ERROR_WRONG_CONTEXT",
"error_description": "The method can only be called 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 |
|
|
The method can only be called in the context of a rest application |
|
|
The element to which the timeline record is linked was not found |
|
|
The timeline record was not found |
|
|
Access denied |
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
- Set a set of additional content blocks in the timeline record crm.timeline.layout.blocks.set
- Delete a set of additional content blocks for the timeline record crm.timeline.layout.blocks.delete
- Example Application with Additional Content Blocks