Документация для разработчиков
Темная тема

Лог-записи таймлайна

Лог-записи - особый вид записей таймлайна, содержащие менее важные данные, чем остальные. Отличаются серым приглушенным фоном и привлекает меньше внимания.

Scope: crm Права на выполнение: для всех

crm.timeline.logmessage.get

crm.timeline.logmessage.get(id: number)

Информация о записи.

Параметры

Параметр Описание Тип
id Идентификатор записи таймлайна

Метод вернет массив, содержащий ассоциативный массив полей лог-записи.

crm.timeline.logmessage.list

crm.timeline.logmessage.list({entityTypeId: number, entityId: number, order: ?{} = null, start: ?number = 0})

Список лог-записей:

Параметр Описание Тип
entityTypeId Идентификатор типа сущности, записи по которой нужно получить.
entityId Идентификатор элемента сущности, записи по которой нужно получить.
order Список для сортировки, где ключ — поле, а значение - asc или desc. По умолчанию используется [id => desc].
start Сдвиг для постраничной навигации.

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

Метод вернет массив, содержащий список лог-записей. Каждая запись содержит ассоциативный массив полей лог-записи.

crm.timeline.logmessage.add

crm.timeline.logmessage.add(fields: {})

Добавить лог-запись

Параметры

Параметр Описание Тип
fields Массив полей добавляемой записи. Может содержать следующие ключи:
  • entityTypeId - идентификатор типа сущности, в которой будет создана запись. Обязательное поле.
  • entityId - идентификатор элемента сущности, в которой будет создана запись. Обязательное поле.
  • title - заголовок записи. Обязательное поле.
  • text - текст записи.
  • iconCode - код иконки. Список доступных кодов можно получить методом [link=]crm.timeline.icon.list[/link].

crm.timeline.logmessage.delete

crm.timeline.logmessage.delete(id: number)

Удалить лог-запись

Параметры

Параметр Описание Тип
id Идентификатор записи таймлайна

Удалить лог запись можно только в контексте того Rest приложения, которое ее создало.

Поля лог-записи таймлайна

Поле Описание Тип
id Идентификатор записи таймлайна int
created Дата и время создания datetime
authorId Пользователь, создавший запись int
title Заголовок записи string
text Содержимое записи string
iconCode Код иконки string




© «Битрикс», 2001-2024, «1С-Битрикс», 2024