Формулировка проблемы: необходимо доработать метод API для получения действий, т.к. в результате реализации задачи 50 итерации 7905 он не был доработан и сейчас отправляет данные, которые не соответствуют настроенному в конфигураторе справочнику send_items.
Затрагивает:
основное приложение:
«Потоки работ» - действия в контекстном меню работ;
«Документы» - действия в карточке документа;
мобильное приложение:
«Работы» - действия на экране информации о работе;
«Документы» - действия на экране информации о документе.
Решение: необходимо реализовать два новых
метода на основе метода
rest/api/workflow/work/get_actions, позволяющего
возвращать набор действий, которые может совершить авторизованный
пользователь над данной работой/документом.
Метод, позволяющий возвращать набор действий для работы
URL метода:
rest/api/workflow/work_actions. Типа запроса:
GET. Кодировка: UTF8.
Метод принимает следующие строковые параметры:
workID - UUID работы
(обяз.);
locale - локаль пользователя,
ru/en/kz (не обяз., по умолчанию
ru).
Альтернативные потоки событий:
Альтернативный поток №1. Параметр workID не
передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр workID
действия не возвращаются;
Альтернативный поток №2. Передан некорректный параметр
workID. Сервер возвращает ошибку:
Некорректный параметр workID
действия не возвращаются.
Метод возвращает массив json со следующими
полями:
action - ID действия:
COMPLETE - завершение;
RESULT - результат;
SEND - отправка;
REASSIGN - перепоручение;
TRANSMIT - передача;
RESOLUTION - резолюция;
operation - ID операции
(может отсутствовать):
PROGRESS - завершение прогрессом;
PROCESS - завершение
согласованием/утвержедием/ознакомлением;
STATUS - завершение статусом;
POINT_RESULT - завершение формой
завершения;
AGREEMENT - согласование;
APPROVAL - утверждение;
ACQUAINTANCE - ознакомление;
label - название действия;
color - ID цвета:
PREFERRED - цвет предпочтительного
действия;
NOT_PREFERRED - цвет не предпочтительного
действия;
POSITIVE - цвет позитивного действия;
NEGATIVE - цвет негативного действия.
Метод, позволяющий возвращать набор действий для документа
URL метода:
rest/api/docflow/document_actions. Типа запроса:
GET.
Метод принимает следующие строковые параметры:
documentID - UUID работы
(обяз.);
locale - локаль пользователя,
ru/en/kz (не обяз., по умолчанию
ru).
Альтернативные потоки событий:
Альтернативный поток №1. Параметр documentID
не передан, либо он пустой. Сервер возвращает ошибку:
Не передан параметр documentID
действия не возвращаются;
Альтернативный поток №2. Передан некорректный параметр
documentID. Сервер возвращает ошибку:
Некорректный параметр documentID
действия не возвращаются.
Метод возвращает массив json со следующими
полями:
action - ID действия:
SEND - отправка;
REASSIGN - перепоручение;
RESOLUTION - резолюция;
REGISTRY - действие по реестру;
operation - ID операции
(может отсутствовать):
AGREEMENT - согласование;
APPROVAL - утверждение;
ACQUAINTANCE - ознакомление;
ANSWER - ответить;
RUN - отправка по маршруту;
label - название действия;
color - ID цвета:
PREFERRED - цвет предпочтительного
действия;
NOT_PREFERRED - цвет не предпочтительного
действия;
POSITIVE - цвет позитивного действия;
NEGATIVE - цвет негативного действия.
Пример возвращаемого массива
[
{
"action": "RESOLUTION",
"operation": "",
"label": "Резолюция",
"color": "PREFERRED"
},
{
"action": "COMPLETE",
"operation": "PROGRESS",
"label": "Завершить",
"color": "NOT_PREFERRED"
},
{
"action": "SEND",
"operation": "AGREEMENT",
"label": "На согласование",
"color": "NOT_PREFERRED"
},
{
"action": "SEND",
"operation": "ACQUAINTANCE",
"label": "На ознакомление",
"color": "NOT_PREFERRED"
},
{
"action": "SEND",
"operation": "APPROVAL",
"label": "На утверждение",
"color": "NOT_PREFERRED"
},
{
"action": "REASSIGN",
"operation": "",
"label": "Перепоручить",
"color": "NOT_PREFERRED"
}
]