|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object kz.arta.synergy.server.api.rest.docs.DocFlowService
public class DocFlowService
Created by vitaliy.zaretskiy on 11.09.14.
Constructor Summary | |
---|---|
DocFlowService()
|
Method Summary | |
---|---|
java.lang.String |
addComment(java.lang.String documentID,
java.lang.String workID,
java.lang.String commentID,
java.lang.String comment,
java.lang.String locale)
Добавляет/изменяет комментарий к документу URL: rest/api/docflow/doc/comments/save Тип POST |
java.lang.String |
addDtiIDLink(java.lang.String dtiId,
java.lang.String docID)
|
java.lang.String |
createAttachment(java.lang.String documentID,
java.lang.String path,
java.lang.String fileName,
java.lang.String filePath,
java.lang.String locale)
Метод добавляет вложение к документу из временного файла, загруженного на сервер с помощью API метода rest/api/storage/start_upload URL: rest/api/docflow/doc/attachment/create Тип: POST |
java.lang.String |
deleteAttachment(java.lang.String fileUUID,
java.lang.String locale)
Метод удаляет вложение URL: rest/api/docflow/doc/attachment/remove Тип GET |
java.lang.String |
deleteComment(java.lang.String commentID,
java.lang.String locale)
Метод удаляет комментарий URL: rest/api/docflow/doc/comments/remove Тип GET |
java.lang.String |
doCreateAttachment(java.lang.String documentID,
java.lang.String path,
java.lang.String fileName,
java.lang.String filePath,
java.lang.String locale,
boolean warning,
java.lang.String successMessage)
|
java.lang.String |
finDocByNumber(java.lang.String number)
API-метод, позволяющий получить идентификатор документа по его номеру (если таких документов несколько, возвращается первый). |
java.lang.String |
getAttachments(java.lang.String documentID,
int count,
boolean getCounters,
java.lang.String locale)
Метод возвращает отсортированный в обратном порядке по дате добавления список файлов документа (из вложений и прочих) URL: /rest/api/doc/last_attachments Тип: GET Возвращает информацию о вложениях как список json. |
java.lang.String |
getChildDocumentsList(java.lang.String documentID,
java.lang.String locale)
Метод возвращает список дочерних документов для родительского URL: rest/api/docflow/doc/child_documents Тип: GET |
java.lang.String |
getComments(java.lang.String documentID,
int start,
int count,
boolean getCounters,
java.lang.String locale)
Метод возвращает комментарии к документу отсортированные в обратном порядке по дате добавления URL: rest/api/docflow/doc/comments/list Method GET Возвращает информацию о комментариях как список json Поле одного комментария commentID - uuid комментария comment - текст комментария author - автор author.userID - uuid автора author.name - имя автора created - дата создания comment_icon_type - тип иконки комментария created_label - время от даты создания либо время создания type - тип комментария (константы в arta.synergy.web.common.client.constants.CommentType) is_editable - возможно ли редактирование данного комментария is_deletable - возможно ли удаление данного комментария Пример получения последних трех комментариев http://хост:порт/Synergy/rest/api/docflow/doc/comments/list? |
java.lang.String |
getDocCode(java.lang.String typeId)
|
java.lang.String |
getDocumentFilters(java.lang.String filterType,
java.lang.String filterID,
java.lang.String objectID,
java.lang.String locale)
Метод возвращает список фильтров в документах по заданным параметрам URL: rest/api/docflow/doc/documents_filters Тип: GET |
java.util.List<arta.synergy.web.common.client.data.bp.ProcessHistory> |
getDocumentHistory(java.lang.String documentID,
java.lang.String locale)
|
java.lang.String |
getDocumentInfo(java.lang.String documentID,
java.lang.String locale)
Метод возвращает полную информацию о документе URL: rest/api/docflow/doc/document_info Тип: GET Пример работы метода: URL: http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/document_info? |
java.lang.String |
getDocumentItems(java.lang.String documentID,
java.lang.String locale)
Метод возвращает набор действий, которые может совершить авторизованный пользователь над документом URL: rest/api/docflow/document_actions Тип: GET Каждое действие характеризуется следующими полями: action - идентификатор действия, значение из kz.arta.synergy.server.api.rest.works.WorkActionType operation - идентификатор операции, значение из kz.arta.synergy.server.api.rest.works.WorkActionSubType (может отсутствовать) label - название действия color - идентификатор цвета, значение из kz.arta.synergy.server.api.rest.works.ActionColor |
java.lang.String |
getDocumentRCC(java.lang.String documentID,
java.lang.String locale)
API-метод, позволяющий получить РКК документа. |
java.lang.String |
getDocumentsList(java.lang.String filterType,
java.lang.String filterID,
java.lang.String objectID,
int pageNumber,
int countInPart,
java.lang.String locale)
Метод возвращает список документов для заданных параметров URL: rest/api/docflow/doc/documents Тип: GET |
java.util.Map<java.lang.String,java.lang.String> |
getDocumetInfo(java.lang.String dtiId,
java.lang.String docID)
|
java.lang.String |
getFavoriteFilters(java.lang.String locale)
Метод возвращает описание избранных фильтров Поведение метода аналогично api методу /rest/api/doc/documents_filters - разница лишь в том, что данный метод не принимает никаких параметров (кроме локали) Если избранных фильтров нет - сервер вернет пустой массив ("[]") URL: rest/api/docflow/doc/favorite_doc_filters Тип: GET |
java.lang.String |
getFullAttachments(java.lang.String documentID,
java.lang.String locale)
Метод возвращает все файлы данного документа по двум группам - вложения и прочие URL: rest/api/docflow/doc/attachments Тип: GET Возвращает информацию о файлах как объект json: {attachments: [..list of attachments ..], work_files: [..list of work files ..]} |
java.lang.String |
getRegUserByDtiID(java.lang.String dtiId)
|
java.lang.String |
getResolutions(java.lang.String workID,
java.lang.String documentID,
java.lang.String locale)
Возвращает информацию о резолюциях URL: rest/api/docflow/doc/get_resolution Тип: GET |
java.lang.String |
getRoutes(java.lang.String search,
boolean bookmarks,
java.lang.String locale)
Получение списка маршрутов доступных пользователю URL: rest/api/docflow/doc/routes Тип: GET |
java.lang.String |
getSignList(java.lang.String documentID,
java.lang.String locale)
API-метод, позволяющий получить список подписей для данного документа. |
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 documentID,
java.lang.String type,
boolean controlled,
java.lang.String projectID,
java.lang.String locale)
Метод сохраняет/подтверждает резолюцию URL: rest/api/docflow/doc/save_resolution Тип: POST |
java.lang.String |
setHidden(java.lang.String documentID,
boolean hidden,
java.lang.String filterType,
java.lang.String locale)
Метод скрывает/восстанавливает документ URL: rest/api/docflow/doc/hide Тип: GET |
java.lang.String |
setSeen(java.lang.String documentID,
boolean seen,
java.lang.String filterType,
java.lang.String locale)
Метод отмечает документ как "Просмотренный" URL: rest/api/docflow/doc/set_seen Тип: GET |
javax.ws.rs.core.Response |
sign(java.lang.String locale,
java.lang.String documentID,
java.lang.String rawdata,
java.lang.String signdata,
java.lang.String certificate,
java.lang.String certID)
API-метод подписания документа URL rest/api/docflow/sign Method POST |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocFlowService()
Method Detail |
---|
public java.lang.String getResolutions(java.lang.String workID, java.lang.String documentID, java.lang.String locale)
workID
- actionID работыdocumentID
- uuid документаlocale
- локаль
[ { "statusID": 0, "projectID": "64750f61-3393-425b-b07d-f63974372fa5", "author": "Messi Leonel", "canEdit": "true", "controlled": "true", "maxFinishDate" : "2014-12-17 00:00:00" "items": [ { "name": "12345", "itemID" : "32310f61-3393-425b-b07d-f63974372fa5", "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", "dict_id": "bebebebe-fefe-cece-dede-1234567890ab", "item_name": "Работа" } ] } ]
public java.lang.String saveResolutionRoute(java.lang.String data, java.lang.String workID, java.lang.String documentID, java.lang.String type, boolean controlled, java.lang.String projectID, java.lang.String locale)
data
- json строка с пунктами резолюцииworkID
- uuid работыdocumentID
- uuid доукментаcontrolled
- "является контрольным" (по умолчанию - false)type
- тип резолюции (SAVE - сохранить, ACCEPT - подтвердить)projectID
- projectID резолюции. можно получить из api метода rest/api/docflow/doc/get_resolution. если создается новая резолюция - передавать этот параметр не надо, во всех остальных случаях надо (редактирование существующей)locale
- локаль
[ { "name": "item 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", "itemID": "52230dc9-e0ca-4a8a-846b-4ea3b9a46150", "dict_id": "fefefefe-cafe-babe-face-1234567890ab" } ]
public java.lang.String saveCorrespondentOrg(java.lang.String name)
name
- название организации(FormParam)
public java.lang.String getDocumentFilters(java.lang.String filterType, java.lang.String filterID, java.lang.String objectID, java.lang.String locale)
filterType
- тип фильтраfilterID
- uuid фильтраobjectID
- objectID фильтраlocale
- локаль
[ { "name": "Журналы", "filterType": "REGISTER_FILTER", "count": "17", "hasChildren": "true" }, { "name": "Дела", "filterType": "DOCFILE_FILTER", "count": "0", "hasChildren": "true" }, { "name": "Все", "filterType": "ALL_USER_DOCUMENTS", "count": "321", "hasChildren": "true" } ]Если параметр hasChildren = true - это значит, что данный фильтр содержит дочерние. К примеру пользователь захотел получить список фильтров, которые находится «внутри» фильтра «Журналы». Чтобы это осуществить — нужно обратиться к этому же методу + добавить один параметр filterType (тип фильтра). URL: http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/documents_filters?filterType=REGISTER_FILTER&locale=ru Сервер вернет описание фильтров второго уровня, к примеру:
[ { "name": "Внутренние документы", "filterType": "REGISTER_FILTER", "objectID": "internal_docs", "count": "2", "hasChildren": "true" }, { "name": "Входящие документы", "filterType": "REGISTER_FILTER", "objectID": "in_docs", "count": "12", "hasChildren": "true" }, { "name": "Договоры", "filterType": "REGISTER_FILTER", "objectID": "2f74f563-7366-4d60-a86d-15843108f256", "count": "0", "hasChildren": "true" } ]Например пользователь захотел провалиться еще глубже, к примеру в фильтр «Внутренние документы». Для этого надо добавить к существующему запросу еще один параметр — objectID. URL: http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/documents_filters?filterType=REGISTER_FILTER?objectID=internal_docs&locale=ru Сервер вернет описание фильтров третьего уровня, к примеру:
[ { "name": "On registration", "filterType": "REGISTER_FILTER", "filterID": "3e54a5c4-603a-418f-bb43-c34117b7f855", "objectID": "internal_docs", "count": "1", "hasChildren": "true" }, { "name": "In progress", "filterType": "REGISTER_FILTER", "filterID": "03f46a0c-bafb-4aa0-b4dd-708be03f5c35", "objectID": "internal_docs", "count": "0", "hasChildren": "true" }, { "name": "Expired", "filterType": "REGISTER_FILTER", "filterID": "8dfdd85d-3c55-47fc-8ab6-d76387e359a0", "objectID": "internal_docs", "count": "0", "hasChildren": "true" } ]Можно попасть на четвертый уровень — в таком случае необходимо еще добавить параметр filterID. URL: http://192.168.2.153:8080/Synergy/rest/api/docflow/doc/documents_filters?filterType=REGISTER_FILTER&objectID=internal_docs&filterID=3e54a5c4-603a-418f-bb43-c34117b7f855&locale=ru Сервер вернет описание фильтров четвертого уровня, к примеру:
[ { "name": "Фильтр четвертого уровня 1", "filterType": "REGISTER_FILTER", "filterID": "8e0b82ff-7832-4e7b-adbe-6b495fe8f617", "objectID": "internal_docs", "count": "1", "hasChildren": "false" }, { "name": "Фильтр четвертого уровня 2", "filterType": "REGISTER_FILTER", "filterID": "e5c62d5e-df03-43cc-8899-c1a91855f432", "objectID": "internal_docs", "count": "1", "hasChildren": "false" } ]Начиная с четвертого уровня — новых параметров не добавляется. Для других фильтров («Дела», «Все») поведение метода аналогично.
public java.lang.String getFavoriteFilters(java.lang.String locale)
locale
- локаль
public java.lang.String getDocumentsList(java.lang.String filterType, java.lang.String filterID, java.lang.String objectID, int pageNumber, int countInPart, java.lang.String locale)
filterType
- тип фильтраfilterID
- id фильтраobjectID
- objectID фильтраlocale
- локаль
[ { "name": "Документ 1", "content" : "", "documentID": "8c081b77-5d03-4ce3-89a8-b551a73fc1d9", "number": "", "author": "Бобров С.Е.", "docTypeId": "inner" "user": "Абдрешен Л.С.", "regUser": "", "resUsers": "", "to": "", "from": "", "correspondent": "", "correspondentOrg": "", "type": "DOCUMENT", "createDate": "2014-11-13 15:50:00", "regDate": "2014-11-13 16:42:00", "statusID": "NOT_STARTED", "isExpired": "false", "isSoonExpired": "true", "hasChildren": "false", "hasResolution": "false", "isNew": "false", "hidden": "false", "registered": "false", "finished": "false", "inProgress": "false", "controlled": "false", "hasAttachments": "true", "defective": "false" } ]Описание параметров: name - краткое содержание документа content - значащее содержимое documentID - uuid документа number - номер документа author - ФИО автора документа docTypeID - тип журнала документа (внутренний, исходящий, входящий) user - ФИО пользователя, которому отписан документ regUser - ФИО пользователя, зарегистрировавшего документ resUsers - ФИО пользователей, у которых документ находится на исполнении to - ФИО адресатов from - ФИО адресантов correspondent - корреспондент correspondentOrg - корреспондент (орг) type - признак происхождения (EMAIL/DOCUMENT) createDate - время и дата создания документа в формате (DD.MM.YY hh:mm) regDate - время и дата регистрации документа в формате (DD.MM.YY hh:mm) statusID - статус документа (NOT_STARTED - на регистрации, IN_PROGRESS - на исполнении, FINISHED - завершен, DRAFT - отклонен) isExpired - хотя бы одна работа по маршруту документа просрочена isSoonExpired - хотя бы у одной работы по маршруту документа истекает срок hasChildren - имеет ли данный документ дочерние hasResolution - наложена ли резолюция на данный документ isNew - есть ли изменения в документе непросмотренные пользователем hidden - скрыт ли документ registered - зарегистрирован ли документ finished - завершен ли документ inProgress - находится ли документ в процессе controlled - является ли документ контрольным hasAttachments - имеет ли данный документ вложения defective - бракованный ли документ Чтобы получить список документов в находящиеся в каком-либо фильтре - нужно передать параметры этого фильтра в текущий метод. (Параметры получаются путем вызова метода /rest/api/doc/documents_filters). К примеру: 1. http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/documents?filterType=REGISTER_FILTER 2. http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/documents?filterType=REGISTER_FILTER&objectID=internal_docs 3. http://127.0.0.1:8080/Synergy/rest/api/docflow/doc/documents?filterType=REGISTER_FILTER&objectID=internal_docs&filterID=3e54a5c4-603a-418f-bb43-c34117b7f855
public java.lang.String getChildDocumentsList(java.lang.String documentID, java.lang.String locale)
documentID
- documentID (uuid родительского документа, для которого получаются дочерние,
имеет смысл передавать только в том случае, если параметр hasChildren у родителя = true)locale
- локаль
public java.lang.String getDocumentInfo(java.lang.String documentID, java.lang.String locale)
[ { "name": "Документ 1", "content" : "", "documentID": "8c081b77-5d03-4ce3-89a8-b551a73fc1d9", "number": "", "author": "Бобров С.Е.", "docTypeId": "inner" "user": "Абдрешен Л.С.", "regUser": "", "resUsers": "", "to": "", "from": "", "correspondent": "", "correspondentOrg": "", "type": "DOCUMENT", "createDate": "2014-11-13 15:50:00", "regDate": "2014-11-13 16:42:00", "statusID": "NOT_STARTED", "isExpired": "false", "isSoonExpired": "true", "hasChildren": "false", "hasResolution": "false", "isNew": "false", "hidden": "false", "registered": "false", "finished": "false", "inProgress": "false", "controlled": "false", "hasAttachments": "true", "defective": "false", "actions" : ["fb051b77-6ds3-4c3f-833a8-b551a73fc1fs"], "bases" : ["3c051b77-5ds3-4ce3-84a8-b551a73fc1d9"] } ]Описание параметров: name - краткое содержание документа content - значащее содержимое documentID - uuid документа number - номер документа author - ФИО автора документа docTypeID - тип журнала документа (внутренний, исходящий, входящий) user - ФИО пользователя, которому отписан документ regUser - ФИО пользователя, зарегистрировавшего документ resUsers - ФИО пользователей, у которых документ находится на исполнении to - ФИО адресатов from - ФИО адресантов correspondent - корреспондент correspondentOrg - корреспондент (орг) type - признак происхождения (EMAIL/DOCUMENT) createDate - время и дата создания документа в формате (DD.MM.YY hh:mm) regDate - время и дата регистрации документа в формате (DD.MM.YY hh:mm) statusID - статус документа (NOT_STARTED - на регистрации, IN_PROGRESS - на исполнении, FINISHED - завершен, DRAFT - отклонен) isExpired - хотя бы одна работа по маршруту документа просрочена isSoonExpired - хотя бы у одной работы по маршруту документа истекает срок hasChildren - имеет ли данный документ дочерние hasResolution - наложена ли резолюция на данный документ isNew - есть ли изменения в документе непросмотренные пользователем hidden - скрыт ли документ registered - зарегистрирован ли документ finished - завершен ли документ inProgress - находится ли документ в процессе controlled - является ли документ контрольным hasAttachments - имеет ли данный документ вложения defective - бракованный ли документ actions - если пользователь по данному документу имеет несколько работ - uuid'ы этих работ будут находиться в массиве actions. bases - основания документа registryID - идентификатор реестра, в котором находится документ (может отсутствовать, если документ не принадлежит никакому реестру) registryName - имя реестра, в котором находится документ (может отсутствовать, если документ не принадлежит никакому реестру) formName - имя формы formID - идентификатор формы asfDataID - идентификатор данных по форме реестра документа (может отсутствовать, если документ не принадлежит никакому реестру) processing - статус записи реестра (true - находится в процессе) activate - статус записи реестра (true - запись активирована)
documentID
- documentIDlocale
- локаль (ru/en/kz)
public java.lang.String getAttachments(java.lang.String documentID, int count, boolean getCounters, java.lang.String locale)
documentID
- uuid документаcount
- количество файлов которое должно быть возвращено (по умолчанию 3)getCounters
- если true - метод так же возвращает общее количество вложений документа (по умолчанию false)locale
- локаль пользователя, по умолчанию ru
public java.lang.String getFullAttachments(java.lang.String documentID, java.lang.String locale)
{ "attachments": [ { "uuid": "d55ae76a-f451-452d-93cb-3c6b28ba2335", "name": "Изображение.jpg", "is_editable": "true", "created_label": "15 минут назад", "created": "2013-06-26 09:12:54", "icon": "preview?identifier=d55ae76a-f451-452d-93cb-3c6b28ba2335" } ], "work_files": [ { "uuid": "d55ae76a-f451-452d-93cb-3c6b28ba2332", "name": "Документ.doc", "is_editable": "true", "created_label": "15 минут назад", "created": "2013-06-26 09:12:54", "icon": "preview?identifier=d55ae76a-f451-452d-93cb-3c6b28ba2332" } ] }
documentID
- - uuid документаlocale
- - локаль пользователя, по умолчанию ru
public java.lang.String createAttachment(java.lang.String documentID, java.lang.String path, java.lang.String fileName, java.lang.String filePath, java.lang.String locale)
Метод добавляет вложение к документу из временного файла, загруженного на сервер с помощью API метода rest/api/storage/start_upload
URL: rest/api/docflow/doc/attachment/create Тип: POST
documentID
- UUID документаpath
- строка показывающая, в какой контейнер необходимо положить файл. (ase:attachmentContainer, ase:workContainer)fileName
- название загружаемого файлаfilePath
- путь к временному файлу, загруженному на серверlocale
- локаль пользователя, по-умолчанию ru
public java.lang.String doCreateAttachment(java.lang.String documentID, java.lang.String path, java.lang.String fileName, java.lang.String filePath, java.lang.String locale, boolean warning, java.lang.String successMessage)
public java.lang.String deleteAttachment(java.lang.String fileUUID, java.lang.String locale)
fileUUID
- идентификатор файла, который надо удалитьlocale
- локаль пользователя (по-умолчанию ru)
public java.lang.String getComments(java.lang.String documentID, int start, int count, boolean getCounters, java.lang.String locale)
documentID
- uuid документаstart
- номер первой записи (отсчет с 0)count
- количество записей в возвращаемом списке (по умолчанию 3)getCounters
- true - получить количество комментариев, иначе - falselocale
- локаль пользователя, по-умолчанию ru
public java.lang.String addComment(java.lang.String documentID, java.lang.String workID, java.lang.String commentID, java.lang.String comment, java.lang.String locale)
documentID
- uuid документаworkID
- uuid работыcommentID
- uuid комментария, для добавления нового комментария - не передаватьcomment
- текст комментария (передается как параметр формы)locale
- локаль пользователя (по-умолчанию ru)
На данный момент поддерживается только один тип simple - к телу комментария добавляются названия объектов.public java.lang.String deleteComment(java.lang.String commentID, java.lang.String locale)
commentID
- uuid комментарияlocale
- локаль пользователя, по-умолчанию - rupublic java.lang.String getDocumentItems(java.lang.String documentID, java.lang.String locale)
documentID
- uuid работыlocale
- локаль пользователя, по-умолчанию ru
WorkActionType
,
WorkActionSubType
,
ActionColor
public java.lang.String setHidden(java.lang.String documentID, boolean hidden, java.lang.String filterType, java.lang.String locale)
documentID
- documentID (uuid документа)filterType
- фильтр, в котором скрывается документhidden
- true - скрыть документ, false - восстановитьlocale
- локаль (ru/en/kz)
DocSearchParams.USER_OWN_DOCUMENTS
,
DocSearchParams.USER_SENT_DOCUMENTS
,
DocSearchParams.USER_RECEIVED_DOCUMENTS
,
DocSearchParams.ALL_USER_DOCUMENTS
public java.lang.String setSeen(java.lang.String documentID, boolean seen, java.lang.String filterType, java.lang.String locale)
documentID
- documentID (uuid документа)seen
- true/false (просмотрен документ либо нет)filterType
- тип фильтра, из которого скрывается документlocale
- локаль (ru/en/kz)
public java.lang.String getRoutes(java.lang.String search, boolean bookmarks, java.lang.String locale)
search
- строка поиска (поиск производится только по наименованию маршрутов)bookmarks
- true - отображать только скрытые, false - отображать все (по умолчанию)locale
- локаль (ru/en/kz)
[ { "routeID": "c4ddd6b1-ade2-4ee2-ace5-aaec6a81d02a", "routeName": "Анализ бухгалтерского баланса", "authorID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "authorName": "Слепаков И.И.", "isBookmark": "false" }, { "routeID": "22a48f88-199a-4398-8eb6-15ba8ef35deb", "routeName": "Анализ бухгалтерского баланса №2", "authorID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "authorName": "Слепаков И.И.", "isBookmark": "true" } ]
public java.lang.String getDocCode(java.lang.String typeId)
public java.lang.String getRegUserByDtiID(java.lang.String dtiId)
public java.lang.String addDtiIDLink(java.lang.String dtiId, java.lang.String docID)
public java.util.Map<java.lang.String,java.lang.String> getDocumetInfo(java.lang.String dtiId, java.lang.String docID)
public java.util.List<arta.synergy.web.common.client.data.bp.ProcessHistory> getDocumentHistory(java.lang.String documentID, java.lang.String locale)
public java.lang.String getDocumentRCC(java.lang.String documentID, java.lang.String locale)
API-метод, позволяющий получить РКК документа.
URL rest/api/docflow/doc/rcc
documentID
- UUID документа (обяз.);locale
- локаль ru/en/kz, по умолчанию ru (не обяз.);
(1) Для документов с типом журнала внутренний:
(2) Для документов с типом журнала входящий:
(3) Для документов с типом журнала исходящий:
для документов с типом журнала входящий:
для документов с типом журнала внутренний:
для документов с типом журнала исходящий:
В случае неуспешного выполнения возвращается json с полями:
Пример возвращаемого массива:
{ "content": "Future requests.", "registerID": "888cfa2e-6d55-4ed5-b1be-890ffad560dq", "registerName": "Исходящие документы", "number": "{obwii}-{dd}.{MM}.{yyyy}", "regDate": "", "correspondentOrg": "", "correspondent": "", "authorID": "179bda2e-6d55-4ed5-b1be-890ffad280ba", "authorName": "Aбдрешен Леонид Аркадьевич", "registeredByID": "", "registeredByName": "" "controlled": true, "caseID": "", "caseName": "", "bases": [], "data":[ { "id": "cmp-numericinput", "type": "numericinput", "value": "20.00" }, { "id": "cmp-id", "type": "personlink", "label": "Label-text", "value": "идентификатор записи адресной книги" } ], "mandatoryFields": [ "caseID", "caseName", "executorID", "executorName" ] }
public java.lang.String finDocByNumber(java.lang.String number)
API-метод, позволяющий получить идентификатор документа по его номеру (если таких документов несколько, возвращается первый).
URL rest/api/docflow/findDocByNumber
number
- номер (обяз.);
В случае неуспешного выполнения возвращается json с полями:
public java.lang.String getSignList(java.lang.String documentID, java.lang.String locale)
API-метод, позволяющий получить список подписей для данного документа.
URL rest/api/docflow/doc/sign_list
documentID
- UUID документа (обяз.)locale
- локаль ru/en/kz, по умолчанию ru (не обяз.)
В случае неуспешного выполнения возвращается json с полями:
Пример возвращаемого массива:
[ { "userID": "179bda2e-6d55-4ed5-b1be-890ffad280ba", "userName": "Калиев И.О.", "userPosition": "Генеральный директор", "date": "2015-05-19 11:12:13", "comment": "", "actionType": "SIGN_ITEM", "signType": "SIMPLE" }, { "userID": "78w96q2e-6d55-4ed5-b1be-890ffad280ba", "userName": "Захаров М.П.", "userPosition": "Заместитель директора", "date": "2015-05-20 10:11:12", "comment": "OK", "actionType": "AGREEMENT_ITEM" "signType": "ECS" } ]
public javax.ws.rs.core.Response sign(java.lang.String locale, java.lang.String documentID, java.lang.String rawdata, java.lang.String signdata, java.lang.String certificate, java.lang.String certID)
API-метод подписания документа
URL rest/api/docflow/sign
locale
- локаль пользователя, по-умолчанию rudocumentID
- UUID документа (обяз.)rawdata
- данные для подписи base64 (обяз.)signdata
- Base64 закодированная строка с подписью (обяз., если включена настройка "Требовать ключ и сертификат")certificate
- сертификат base64 (обяз. если включена настройка требовать ключ и сертификат)certID
- идентификатор сертификата, получаемый в методе verificationkey (certID::::sigalg) (обяз., если включена настройка "Требовать ключ и сертификат");
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |