Перейти к основному содержимому

GetPartnerEventsRequest

Запрос на получение списка событий, произошедших с документами во всех ящиках, доступных технологическому партнеру, методом GetPartnerEvents.

message GetPartnerEventsRequest {
optional string Cursor = 1;
repeated string DocumentDirections = 2;
repeated string MessageTypes = 3;
optional int32 Limit = 4 [default = 100];
optional bool PopulatePreviousDocumentStates = 5 [default = false];
}
  • Cursor — ключ для постраничного получения найденных событий. Может быть пустым.

  • DocumentDirections — список направлений документа относительно текущих ящиков. Направление документа принимает значения:

    • Inbound — входящий,
    • Outbound — исходящий,
    • Internal — внутренний.

    Параметр нерегистрочувствительный. Если не указан, то фильтр по направлению документа не будет применен. Если в списке будут указаны дублированные значения, то они дедуплицируются.

    Параметр применим в том числе к шаблонам и черновикам. Для шаблонов параметр указывает направление самого шаблона, а не документов, созданных на его основе. Черновики попадают в результат поиска только при значении DocumentDirections = Outbound.

  • MessageTypes — список типов сообщения. Тип сообщения принимает значения:

    • Draft — черновик,
    • Letter — письмо,
    • Template — шаблон.

    Параметр нерегистрочувствительный. Если не указан, то фильтр по типу сообщения не будет применен. Если в списке будут указаны дублированные значения, то они дедуплицируются.

  • Limit — максимальное количество событий, которое нужно загрузить в ответе. Не влияет на общее количество всех найденных событий. Принимает значения от 1 до 500. По умолчанию имеет значение 100.

  • PopulatePreviousDocumentStates — признак того, что в результат нужно включить полное состояние документа на момент предыдущего события — метаданные и документооборот. По умолчанию имеет значение false.


См. также

Структура используется:

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года