Новые условия фильтрации в методах API GetNewEvents и GetDocflowEvents (версия 3)

6 августа 2021
Работа системы

 

В API для методов GetNewEvents и GetDocflowEvents (версия 3) добавятся новые условия фильтрации по критериям:

  • подразделение;
  • тип документа;
  • тип сообщения (письмо, черновик, шаблон);
  • контрагент;
  • направление документооборота (входящий, исходящий, внутренний);
  • время возникновения события.

Дополнительные условия фильтрации будут доступны в новой версии метода V7/GetNewEvents и текущей версии GetDocflowEvents (версия 3) до конца августа.

Мы продолжим поддерживать V6/GetNewEvents, в SDK будет только последняя версия — V7/GetNewEvents.

V7/GetNewEvents

Метод на вход будет принимать параметры:

  • идентификатор ящика;
  • идентификатор последнего полученного события (может отсутствовать); 
  • ключ события, используемый для постраничной выгрузки (может отсутствовать); 
  • идентификатор подразделения (может отсутствовать); 
  • тип сообщения (может отсутствовать); 
  • идентификатор типа документа (можно указать несколько идентификаторов, может отсутствовать); 
  • направление документа относительно данного ящика (может отсутствовать); 
  • метка времени, задающая начальную точку периода (может отсутствовать);
  • метка времени, задающая конечную точку периода (может отсутствовать);
  • идентификатор ящика контрагента (может отсутствовать);
  • порядок сортировки документов в выдаче по времени возникновения события (по умолчанию сортировка по возрастанию, может отсутствовать);
  • максимальное количество документов в ответе (по умолчанию — 100, может отсутствовать).

В ответе метода в контракте BoxEvent будет добавлен вывод ключа события. Используется для постраничной выгрузки и позволяет указать, с какого события выгружать очередную страницу.

GetDocflowEvents (версия 3)

Метод на вход будет принимать параметры:

  • идентификатор ящика;
  • максимальное количество документов в ответе (по умолчанию — 100, может отсутствовать).

В контракт запроса будут добавлены поля:

  • идентификатор подразделения (может отсутствовать); 
  • тип сообщения (может отсутствовать); 
  • идентификатор типа документа (можно указать несколько идентификаторов, может отсутствовать); 
  • направление документа относительно данного ящика (может отсутствовать);
  • идентификатор ящика контрагента (может отсутствовать).

Фильтрация по подразделениям

V6/GetNewEvents

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

V7/GetNewEvents

Добавляется фильтрация по подразделениям, которая осуществляется согласно логике:

  • Нет фильтра по подразделению: возвращаются события по всем подразделениям. Не задавать этот фильтр могут только пользователи с доступом ко всем подразделениям.
  • Есть фильтр по подразделению: возвращаются события по документам только указанного подразделения. Задать можно любое подразделение, к документам которого пользователь имеет доступ.

GetDocflowEvents (версия 3)

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

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

 
Комментировать