crm.timeline.note.get
Получить информацию о заметке
Описание
Метод возвращает информацию о заметке к записи таймлайна.
Параметры
ownerTypeId
integer
обязательный
Идентификатор типа элемента, к которому относится запись
ownerId
integer
обязательный
Идентификатор элемента, к которому относится запись
itemType
integer
обязательный
Тип записи, к которой нужно применить заметку:
1— запись истории2— дело
itemId
integer
обязательный
Идентификатор записи, к которой нужно применить заметку. Если itemType=1, то это идентификатор записи истории таймлайна. Если itemType=2, то это идентификатор дела
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":1,"itemType":1,"itemId":2}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.note.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerTypeId":1,"ownerId":1,"itemType":1,"itemId":2,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.timeline.note.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type NoteGetResult = {
text: string
createdById: number
createdTime: ISODate | null
updatedById: number
updatedTime: ISODate | null
}
try {
const response = await $b24.actions.v2.call.make<NoteGetResult>({
method: 'crm.timeline.note.get',
params: {
ownerTypeId: 1,
ownerId: 1,
itemType: 1,
itemId: 2,
},
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(result.text, result.createdById, result.createdTime)
}
} 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 getTimelineNote() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.timeline.note.get',
params: {
ownerTypeId: 1,
ownerId: 1,
itemType: 1,
itemId: 2,
},
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(result.text, result.createdById, result.createdTime)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getTimelineNote)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.timeline.note.get(
entity_type_id=2,
entity_id=15,
item_type=1,
item_id=128,
).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.timeline.note.get',
[
'ownerTypeId' => 1,
'ownerId' => 1,
'itemType' => 1,
'itemId' => 2,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting timeline note: ' . $e->getMessage();
}
BX24.callMethod(
"crm.timeline.note.get",
{
ownerTypeId: 1,
ownerId: 1,
itemType: 1,
itemId: 2,
}, result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.timeline.note.get',
[
'ownerTypeId' => 1,
'ownerId' => 1,
'itemType' => 1,
'itemId' => 2
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.timeline.note.get", b24.Params{
"ownerTypeId": 1,
"ownerId": 1,
"itemType": 1,
"itemId": 2,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.timeline.note.get: %w", err)
}
var item struct {
Text string `json:"text"`
CreatedByID b24.ID `json:"createdById"`
CreatedTime string `json:"createdTime"`
UpdatedByID b24.ID `json:"updatedById"`
UpdatedTime string `json:"updatedTime"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Text, item.CreatedByID)
Ответ
HTTP-статус: 200
{
"result": {
"text": "Test note",
"createdById": 1,
"createdTime": "2024-03-17T15:55:10+03:00",
"updatedById": 1,
"updatedTime": "2024-03-17T15:55:10+03:00"
},
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Возвращаемые данные
result
object
Информация о найденной заметке (подробное описание)
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "NOT_FOUND",
"error_description": "Элемент не найден"
}
| Код | Описание | Значение |
|---|---|---|
ACCESS_DENIED |
Недостаточно прав | |
NOT_FOUND |
Элемент не найден | |
100 |
Не переданы обязательные поля | |
0 |
Другие ошибки (например, фатальные ошибки) |

