GetDocflowEventsRequest
Запрос на получение событий методом GetDocflowEvents (V4).
message GetDocflowEventsRequest {
required TimeBasedFilter Filter = 1;
optional bytes AfterIndexKey = 2;
optional bool PopulateDocuments = 3 [default = false];
optional bool InjectEntityContent = 4 [default = false];
optional bool PopulatePreviousDocumentStates = 5 [default = false];
repeated string MessageTypes = 6;
repeated string DocumentDirections = 7;
optional string DepartmentId = 8;
repeated string TypeNamedIds = 9;
optional string CounteragentBoxId = 10;
optional int32 Limit = 11 [default = 100];
}
-
Filter— фильтр, задающий временные рамки, которым должны удовлетворять события. Представленный структурой TimeBasedFilter. -
AfterIndexKey— ключ для постраничного получения списка найденных событий, указывающий на начало очередной страницы. -
PopulateDocuments— признак того, что в результат нужно включить полное состояние документа — метаданные и документооборот. По умолчанию имеет значениеfalse. -
InjectEntityContent— признак того, что в результат нужно включить содержимое документа. По умолчанию имеет значениеfalse. -
PopulatePreviousDocumentStates— признак того, что в результат нужно включить полное состояние документа на момент предыдущего события — метаданные и документооборот. Признак аналогиченPopulateDocumentsи может быть установлен одновременно с ним. По умолчанию имеет значениеfalse. -
MessageTypes— список типов сообщения. Тип сообщения принимает значения:Параметр нерегистрочувствительный. Если не указан, то фильтр по типу сообщения не будет применен. Если в списке будут указаны дублированные значения, то они дедуплицируются.
-
DocumentDirections— список направлений документа относительно текущего ящика. Направление документа принимает значения:Inbound— входящий,Outbound— исходящий,Internal— внутренний.
Параметр нерегистрочувствительный. Если не указан, то фильтр по направлению документа не будет применен. Если в списке будут указаны дублированные значения, то они дедуплицируются.
Параметр применим в том числе к шаблонам и черновикам. Для шаблонов параметр указывает направление самого шаблона, а не документов, созданных на его основе. Черновики попадают в результат поиска только при значении
DocumentDirections = Outbound. -
DepartmentId— идентификатор подразделения, из которого нужно получить документы. Если параметр задан, то в результате вернутся все события по указанному подразделению, независимо от текущего нахождения документа. Может отсутствовать, если пользователь имеет доступ ко всем документам организации, иначе является обязательным. Можно указать любое подразделение, к документам которого пользователь имеет доступ. -
TypeNamedIds— список строковых идентификаторов типа документа. Доступные типы можно получить с помощью метода GetDocumentTypes (V3). -
CounteragentBoxId— идентификатор ящика контрагента — промежуточного или конечного получателя. Имеет смысл только при при значениях поляDocumentDirections = InboundиDocumentDirections = Outbound. Если идентификатор ящика контрагента указан приDocumentDirections = Internal, то в результате не вернется ни один документ. -
Limit— максимальное количество событий, которое нужно загрузить в ответе. Не влияет на общее количество всех найденных событий. Принимает значения от 1 до 500. По умолчанию имеет значение 100.
См. также
Структура используется:
- в теле запроса метода GetDocflowEvents (V4)
- в теле запроса устаревшего метода GetDocflowEvents (V3)