метод REST scope: crm

crm.timeline.logmessage.list

Получить список лог-записей таймлайна

Кто может выполнять: пользователь с правом на чтение элемента CRM, в котором находится запись

Описание

Метод получает список лог-записей таймлайна.

Важно иметь в виду, что метод сможет получить данные только о записях, ранее добавленных с помощью crm.timeline.logmessage.add. Системные записи с помощью crm.timeline.logmessage.list получить невозможно.

Параметры

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

Идентификатор типа сущности, для которой нужно получить список лог-записей (например, 1 — лид)

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

Идентификатор элемента сущности, для которого нужно получить список лог-записей (например, 1)

order object необязательный

Список для сортировки, где ключ — поле, а значение — asc или desc.

По умолчанию используется desc.

Сортировка поддерживается только по полям id и created

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

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный: 10 записей.

Чтобы выбрать вторую страницу результатов, необходимо передавать значение 10. Чтобы выбрать третью страницу результатов — значение 20 и так далее.

Формула расчета значения параметра start:

start = (N - 1) * 10, где N — номер нужной страницы

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"entityTypeId":1,"entityId":1,"order":{"created":"desc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.timeline.logmessage.list

Ответ

HTTP-статус: 200

{
    "result": [
        {
            "id": 42074,
            "created": "2024-04-03T10:26:32+02:00",
            "authorId": 1,
            "title": "Test title new",
            "text": "Test note new",
            "iconCode": "info"
        },
        {
            "id": 42073,
            "created": "2024-04-03T10:26:32+02:00",
            "authorId": 1,
            "title": "Test title",
            "text": "Test note",
            "iconCode": "info"
        }
    ],
    "total": 2,
    "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 array

Корневой элемент ответа.

Поле result содержит массив, каждая запись которого содержит ассоциативный массив полей лог-записи logMessage

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": "100",
    "error_description": "Could not find value for parameter {entityTypeId}"
}
Код Описание Значение
100 Не переданы обязательные поля
0 Другие ошибки (например, фатальные)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.