Формулировка проблемы: необходимо реализовать API для скрытия / восстановления документов.
Решение: необходимо реализовать следующий метод:
URL: rest/api/docflow/doc/hide
.
Типа: GET
.
Метод принимает следующие строковые параметры:
documentID
- UUID
документа (обяз.);
hidden
- скрытие документа (не обяз.):
true
- скрыть документ (по умолчанию);
false
- восстановить документ;
filterType
- тип фильтра, в котором
скрывается документ (обяз.):
ALL_USER_DOCUMENTS
- все документы, к
которым пользователь имеет доступ;
USER_OWN_DOCUMENTS
- все собственные
документы пользователя;
USER_RECEIVED_DOCUMENTS
- все полученные
пользователем документы, в которых он не является автором;
USER_SENT_DOCUMENTS
- все отправленные
пользователем документы, в которых он не является автором;
locale
- локаль пользователя,
ru/en/kz
(не обяз., по умолчанию
ru
).
В случае успешного выполнения метода сервер вернет сообщение
Успешно
.
При скрытии / восстановлении документа, который ранее был скрыт / восстановлен, выполнение метода также считается успешным.
Альтернативные потоки событий
Альтернативный поток №1. Параметр documentID
не передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр documentID
действие не осуществляется;
Альтернативный поток №2. Передан некорректный параметр
documentID
. Сервер возвращает ошибку:
Передан некорректный параметр documentID
действие не осуществляется;
Альтернативный поток №3. Параметр filterType
не передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр filterType
действие не осуществляется;
Альтернативный поток №4. Передан некорректный параметр
filterType
. Сервер возвращает ошибку:
Передан некорректный параметр filterType
действие не осуществляется.