kz.arta.synergy.server.api.rest.docs
Class DocFlowService

java.lang.Object
  kz.arta.synergy.server.api.rest.docs.DocFlowService

public class DocFlowService
extends java.lang.Object

Created by vitaliy.zaretskiy on 11.09.14.

Constructor Summary

DocFlowService()

Method Summary

java.lang.String	getResolutions(java.lang.String workID, java.lang.String locale) Возвращает информацию о резолюциях Тип: GET URL: rest/api/docflow/doc/get_resolution
java.lang.String	saveCorrespondentOrg(java.lang.String name) Добавление корреспондента-организации в общесистемный список Тип: POST URL: rest/api/docflow/doc/create_correspondent_org
java.lang.String	saveResolutionRoute(java.lang.String data, java.lang.String workID, java.lang.String type, boolean controlled, java.lang.String projectID, java.lang.String locale) Метод сохраняет/подтверждает резолюцию Тип: POST URL: rest/api/docflow/doc/save_resolution

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocFlowService

public DocFlowService()

Method Detail

getResolutions

public java.lang.String getResolutions(java.lang.String workID,
                                       java.lang.String locale)

Возвращает информацию о резолюциях
Тип: GET
URL: rest/api/docflow/doc/get_resolution

Parameters:

workID - - actionID работы

locale - - локаль

Returns:

json массив с описанием резолюций

Пример:
[
{
"statusID": 0,
"projectID": "64750f61-3393-425b-b07d-f63974372fa5",
"author": "Messi Leonel",
"canEdit": "true",
"controlled": "true",
"items": [
{
"name": "12345",
"userID": "e45a1a15-3c8a-434f-afa7-4d4df8baa579",
"user": "Messi Leonel",
"users": [
{
"user": "AAПроверка AA",
"userID": "9a426339-a140-4ca1-ada5-e441257660f1"
},
{
"user": "AABBCC ddff",
"userID": "da902b13-a3e8-4e7e-adfd-0bf5e67be5ae"
}
],
"finishdate": {
"date": "1414519200000"
},
"typeID": 3,
"completionFormID": "4eb20dc9-e0ca-4a8a-846b-4ea3b9a46150"
}
]
}
]

В данном примере видим, что наложена одна резолюция. Может быть и больше. Если резолюций вообще нет - сервер вернет пустую резолюцию.

Параметры описания резолюции:
statusID - статус резолюции (0 - резолюция сохранена, 1 - резолюция наложена, 2 - резолюция удалена)
projectID - projectID резолюции. нужен для редактирования резолюции, этот projectID будет передан в апи метод /doc/save_resolution
author - автор резолюции
canEdit - есть ли возможность редактировать резолюцию текущему пользователю
controlled - выставлена ли галочка "Является контрольным"
items - пункты резолюции

Параметры пунктов резолюции:
name - имя пункта резолюции
userID - uuid ответственного
user - имя ответственного
users - исполнители
finishdate - дата завершения в миллисекундах
type - тип (3 - работа, 0 - согласование, 1 - утверждение, 2 - ознакомление, 17 - отправка документа, 28 - блокирующий процесс)
completionFormID - id формы завершения

saveResolutionRoute

public java.lang.String saveResolutionRoute(java.lang.String data,
                                            java.lang.String workID,
                                            java.lang.String type,
                                            boolean controlled,
                                            java.lang.String projectID,
                                            java.lang.String locale)

Метод сохраняет/подтверждает резолюцию
Тип: POST
URL: rest/api/docflow/doc/save_resolution

Parameters:

data - - json строка с пунктами резолюции

workID - - actionID работы

controlled - - "является контрольным" (по умолчанию - false)

type - - тип резолюции (SAVE - сохранить, ACCEPT - подтвердить)

projectID - - projectID резолюции. можно получить из апи метода rest/api/docflow/doc/get_resolution. если создается новая резолюция - передавать этот параметр не надо, во всех остальных случаях надо (редактирование существующей)

locale - - локаль

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка)

Пример строки data:
[
{
"name": "punkt 1",
"userID": "fdb874fa-e5cf-4454-bd7c-1727fed23a3e",
"usersID": [
"fdb874fa-e5cf-4454-bd7c-1727fed23a3e",
"c6caf840-d39b-41fc-83c6-e015a264677a"
],
"finishDate": "1411722780000",
"typeID": "0",
"completionFormID": "4eb20dc9-e0ca-4a8a-846b-4ea3b9a46150"
}
]

где:

name - имя резолюции
userID - id ответственного
usersID - айдишники исполнителей
finishDate - время завершения в миллисекундах
typeID - тип резолюции (3 - работа, 0 - согласование, 1 - утверждение, 2 - ознакомление, 17 - отправка документа, 28 - блокирующий процесс)
completionFormID - id формы завершения

saveCorrespondentOrg

public java.lang.String saveCorrespondentOrg(java.lang.String name)

Добавление корреспондента-организации в общесистемный список
Тип: POST
URL: rest/api/docflow/doc/create_correspondent_org

Parameters:

name - - название организации(FormParam)

Returns:

json объект с полями - errorCode - код выполнения операции (0 успешно, иначе - ошибка)