Параметри пошуку подій (об’єкт EventsStorageQuery)

JSON:

{
  "fromId": 21,
  "loadBody": true,
  "loadComments": true,
  "loadStatuses": true,
  "loadTags": true,
  "loadChain": true,
  "loadAttachments": true
}

Таблиця 1 - Опис параметрів об’єкта EventsStorageQuery

Параметр

Тип 1

Формат

Опис

Об’єкт EventsStorageQuery

fromId

M

long

ідентифікатор події, після якої (починаючи з наступної) необхідно отримати список наступних подій

limit

O

int

кількість подій, що будуть повенені за пошуком. Max=100 (за замовчуванням)

skipTypes

O

List<Integer>

масив; типи подій, що НЕ потрібно враховувати при пошуку

  • 0 - новий відправлений документ (метод відправки документів через API);

  • 1 - створено чернетку;

  • 2 - створено новий вхідний документ;

  • 3 - у документа змінився статус;

  • 4 - у документа змінився сабстатус (детальніше про exchange_status);

  • 5 - документ змінився (всі інші зміни документа поза зміною статусу та сабстатусу);

  • 6 - чернетку видалено

loadBody

O

boolean

передавати у відповіді пошуку тіло документа

loadComments

O

boolean

передавати у відповіді пошуку коментарі документа

loadStatuses

O

boolean

передавати у відповіді пошуку статуси документа

loadTags

O

boolean

передавати у відповіді пошуку теги документа

loadChain

O

boolean

передавати у відповіді пошуку дані пов’язаного ланцюжка документів

loadAttachments

O

boolean

передавати у відповіді пошуку вкладення до документа


1

Під визначенням колонки Тип поля мається на увазі скорочене позначення:

  • M (mandatory) — обов’язкові до заповнення поля;

  • O (optional) — необов’язкові (опціональні) до заповнення поля.