public interface ProjectTemplateService
Modifier and Type | Method and Description |
---|---|
void |
changeVisibility(java.lang.String id,
boolean visible)
Изменяет видимость шаблона
URL: /rest/projects/templates/{id}/visible/{true | false} Метод: POST |
java.util.Set<java.lang.String> |
filterDictionaryItems(java.util.Set<java.lang.String> idsToFilter)
arta.synergy.common.mbo.actions.ActionsIF#filterWorkResultDicItems(Set) |
PlanTemplate |
get(java.lang.String id)
Возвращает шаблон проекта с заданным id
JSON ответа - список объектов, описанных в
saveTemplate(String, PlanTemplate) , за исключением рисков и
отображаемых полей, которые null. |
java.util.List<PlanTemplateAction> |
getActions(java.lang.String templateId)
Возвращает список действий для шаблона
URL: /rest/projects/templates/actions/list Метод: GET |
<any> |
getTemplateForm(java.lang.String actionId)
arta.synergy.common.mbo.actions.ActionsIF#getProjectTemplate(String) |
java.util.List<PlanTemplateName> |
getTemplateNames()
Возвращает список названий шаблонов, их id и коды.
|
java.lang.Integer |
getTemplatePages(int countInPart,
java.lang.String search)
Возвращает количество страниц при заданных параметрах.
|
java.util.List<PlanTemplate> |
list(ProjectTemplateSearchParams params)
Возвращает список всех шаблонов, удовлетворяющих запросу.
|
<any> |
newTemplate(PlanTemplate template)
Добавляет новый шаблон.
|
<any> |
saveTemplate(java.lang.String id,
PlanTemplate template)
Сохраняет шаблон проекта
URL: /rest/projects/templates/{id} Метод: POST JSON запроса: calcType - int тип расчета сроков 0 - автоматический 1 - ручной progressCalcType - int тип расчета прогресса 0 - Среднее арифметическое 1 - Среднее взвешенное progressRecalculation - boolean перерасчет прогресса при изменении сроков true - настройка включена false - настройка выключена actionWeightField - String вес мероприятия (строка) datesType - int тип ввода сроков 0 - стандартный (дата начала и длительность) 1 - абсолютный (дата начала и завершения) progressType - int тип прогресса 1 - фактический прогресс / прогресс по работе 2 - фактический прогресс / плановый прогресс id - String идентификатор шаблона name - String название шаблона code - String код шаблона visible - boolean признак видимости шаблона true - видимый false - скрыт risks - список рисков riskID - String идентификатор риска riskName - String название риска planID - String идентификатор проекта enterDate - Date дата начала deleted - Date удален ли риск authorInfo: userID - String идентификатор владельца проекта userName - String имя владельца проекта resUserInfo userID - String идентификатор ответственного userName - String имя ответственного probability - int вероятность impact - int воздействие description - String описание риска (мероприятия) statusID - int идентификатор статус status - String название статуса typeID - String идентификатор типа риска typeName - String тип риска fields - List String список отображаемых полей length - длительность start_date - начало finish_date - завершение depends_on - зависит responsible - ответственный cost_planned - плановая стоимость cost_fact - фактическая стоимость percent - прогресс actions - List PlanTemplateAction список мероприятий: id - String идентификатор мероприятия structNumber - List Integer структурный номер мероприятия name - String название мероприятия duration - double длительность мероприятия (в днях) links - List PlanLink зависимости мероприятия: fromSN - StructNumber структурный номер мероприятия, от которого зависит данное linkType - enum PlanLinkType тип зависимости SS - зависимость типа Начало-Начало SF - зависимость типа Начало-Окончание FS - зависимость типа Окончание-Начало FF - зависимость типа Окончание-Окончание delay - int задержка (в днях) valid - boolean признак валидности зависимости true - валидна false - не валидна parentId - String идентификатор родительского мероприятия Пример: { "settings": { "calcType": 0, "progressCalcType": 0, "progressRecalculation": false, "actionWeightField": null, "datesType": 0, "progressType": 1 }, "id": "dd081e05-7a2c-454b-9972-441fd465704a", "name": "example", "code": "example", "visible": true, "risks": [ { "riskID": null, "riskName": "example_risk", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": null, "deleted": null, "authorInfo": { "userID": "1", "userName": null }, "resUserInfo": { "userID": null, "userName": null }, "probability": 13, "impact": 50, "description": "Мероприятия по риску", "statusID": 3, "status": "Проводятся мероприятия", "typeID": "inst", "typeName": "Институциональные риски" }, { "riskID": "a2c32707-8a1b-4fba-8609-ca54adb554db", "riskName": "dsfdfsdf", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": "2015-08-12T00:00:00.000+0600", "deleted": "2015-08-12T11:12:08.076+0600", "authorInfo": { "userID": "0a9eb338-9176-4ae3-8f0f-c3800f5685d9", "userName": "Иванов И." }, "resUserInfo": { "userID": null, "userName": "" }, "probability": 13, "impact": 50, "description": "Описание мероприятий по риску", "statusID": 2, "status": "Запланирован", "typeID": "inst", "typeName": "Институциональные риски" } ], "fields": [ "length", "start_date", "finish_date", "depends_on", "responsible", "percent" ], "actions": [ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [] }, "name": "example", "duration": 1, "links": null, "parentId": null } ] } |
java.util.List<PlanTemplate> list(ProjectTemplateSearchParams params)
get(String)
{ "ascending": true, "search": "тест", "pageNumber": 0, "countInPart": 30 }
params
- параметры поискаPlanTemplate get(java.lang.String id)
saveTemplate(String, PlanTemplate)
, за исключением рисков и
отображаемых полей, которые null.
id
- id шаблонаsaveTemplate(String, PlanTemplate)
, за исключением рисков и
отображаемых полей, которые null.<any> saveTemplate(java.lang.String id, PlanTemplate template)
{ "settings": { "calcType": 0, "progressCalcType": 0, "progressRecalculation": false, "actionWeightField": null, "datesType": 0, "progressType": 1 }, "id": "dd081e05-7a2c-454b-9972-441fd465704a", "name": "example", "code": "example", "visible": true, "risks": [ { "riskID": null, "riskName": "example_risk", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": null, "deleted": null, "authorInfo": { "userID": "1", "userName": null }, "resUserInfo": { "userID": null, "userName": null }, "probability": 13, "impact": 50, "description": "Мероприятия по риску", "statusID": 3, "status": "Проводятся мероприятия", "typeID": "inst", "typeName": "Институциональные риски" }, { "riskID": "a2c32707-8a1b-4fba-8609-ca54adb554db", "riskName": "dsfdfsdf", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": "2015-08-12T00:00:00.000+0600", "deleted": "2015-08-12T11:12:08.076+0600", "authorInfo": { "userID": "0a9eb338-9176-4ae3-8f0f-c3800f5685d9", "userName": "Иванов И." }, "resUserInfo": { "userID": null, "userName": "" }, "probability": 13, "impact": 50, "description": "Описание мероприятий по риску", "statusID": 2, "status": "Запланирован", "typeID": "inst", "typeName": "Институциональные риски" } ], "fields": [ "length", "start_date", "finish_date", "depends_on", "responsible", "percent" ], "actions": [ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [] }, "name": "example", "duration": 1, "links": null, "parentId": null } ] }
void changeVisibility(java.lang.String id, boolean visible)
id
- - идентификатор шаблонаvisible
- - видимость. Возможные варианты: true - видимый, false - скрытый<any> newTemplate(PlanTemplate template)
saveTemplate(String, PlanTemplate)
,
но id шаблона должно быть null.
Возвращает JSON шаблона проектов, описанный в get(String)
template
- - новый шаблонjava.lang.Integer getTemplatePages(int countInPart, java.lang.String search)
countInPart
- количество элементов на страницеsearch
- строка поискаjava.util.List<PlanTemplateAction> getActions(java.lang.String templateId)
templateId
- id шаблона[ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [1,2,3] }, "name": "example", "duration": 1, "links": null, "parentId": null } ]
java.util.List<PlanTemplateName> getTemplateNames()
[ { "name": "1000005", "id": "1a8ce533-57c9-47fb-b102-fc60d4ab5a32", "code": "hgsudshguopsdjg" }, { "name": "1000005", "id": "ad20fc0c-0202-4e85-8d5c-ba5d67100d97", "code": "1000005" }, { "name": "1000010", "id": "1bc126a4-b56d-4598-84f3-445da8fd3bdf", "code": "1000010" }, { "name": "100006", "id": "0c151228-8e24-4eb9-bda5-773a054c4e5a", "code": "100006" } ]
java.util.Set<java.lang.String> filterDictionaryItems(java.util.Set<java.lang.String> idsToFilter)
arta.synergy.common.mbo.actions.ActionsIF#filterWorkResultDicItems(Set)
<any> getTemplateForm(java.lang.String actionId)
arta.synergy.common.mbo.actions.ActionsIF#getProjectTemplate(String)
public class ProjectTemplateService extends java.lang.Object implements ProjectTemplateService
Constructor and Description |
---|
ProjectTemplateService() |
Modifier and Type | Method and Description |
---|---|
void |
changeVisibility(java.lang.String id,
boolean visible)
Изменяет видимость шаблона
URL: /rest/projects/templates/{id}/visible/{true | false} Метод: POST |
java.util.Set<java.lang.String> |
filterDictionaryItems(java.util.Set<java.lang.String> idsToFilter)
arta.synergy.common.mbo.actions.ActionsIF#filterWorkResultDicItems(Set) |
PlanTemplate |
get(java.lang.String id)
Возвращает шаблон проекта с заданным id
JSON ответа - список объектов, описанных в
ProjectTemplateService.saveTemplate(String, PlanTemplate) , за исключением рисков и
отображаемых полей, которые null. |
java.util.List<PlanTemplateAction> |
getActions(java.lang.String templateId)
Возвращает список действий для шаблона
URL: /rest/projects/templates/actions/list Метод: GET |
<any> |
getTemplateForm(java.lang.String actionId)
arta.synergy.common.mbo.actions.ActionsIF#getProjectTemplate(String) |
java.util.List<PlanTemplateName> |
getTemplateNames()
Возвращает список названий шаблонов, их id и коды.
|
java.lang.Integer |
getTemplatePages(int countInPart,
java.lang.String search)
Возвращает количество страниц при заданных параметрах.
|
java.util.List<PlanTemplate> |
list(ProjectTemplateSearchParams params)
Возвращает список всех шаблонов, удовлетворяющих запросу.
|
<any> |
newTemplate(PlanTemplate template)
Добавляет новый шаблон.
|
java.lang.String |
saveLink(java.lang.String structNumber,
java.lang.String link,
java.lang.String locale) |
<any> |
saveTemplate(java.lang.String id,
PlanTemplate template)
Сохраняет шаблон проекта
URL: /rest/projects/templates/{id} Метод: POST JSON запроса: calcType - int тип расчета сроков 0 - автоматический 1 - ручной progressCalcType - int тип расчета прогресса 0 - Среднее арифметическое 1 - Среднее взвешенное progressRecalculation - boolean перерасчет прогресса при изменении сроков true - настройка включена false - настройка выключена actionWeightField - String вес мероприятия (строка) datesType - int тип ввода сроков 0 - стандартный (дата начала и длительность) 1 - абсолютный (дата начала и завершения) progressType - int тип прогресса 1 - фактический прогресс / прогресс по работе 2 - фактический прогресс / плановый прогресс id - String идентификатор шаблона name - String название шаблона code - String код шаблона visible - boolean признак видимости шаблона true - видимый false - скрыт risks - список рисков riskID - String идентификатор риска riskName - String название риска planID - String идентификатор проекта enterDate - Date дата начала deleted - Date удален ли риск authorInfo: userID - String идентификатор владельца проекта userName - String имя владельца проекта resUserInfo userID - String идентификатор ответственного userName - String имя ответственного probability - int вероятность impact - int воздействие description - String описание риска (мероприятия) statusID - int идентификатор статус status - String название статуса typeID - String идентификатор типа риска typeName - String тип риска fields - List String список отображаемых полей length - длительность start_date - начало finish_date - завершение depends_on - зависит responsible - ответственный cost_planned - плановая стоимость cost_fact - фактическая стоимость percent - прогресс actions - List PlanTemplateAction список мероприятий: id - String идентификатор мероприятия structNumber - List Integer структурный номер мероприятия name - String название мероприятия duration - double длительность мероприятия (в днях) links - List PlanLink зависимости мероприятия: fromSN - StructNumber структурный номер мероприятия, от которого зависит данное linkType - enum PlanLinkType тип зависимости SS - зависимость типа Начало-Начало SF - зависимость типа Начало-Окончание FS - зависимость типа Окончание-Начало FF - зависимость типа Окончание-Окончание delay - int задержка (в днях) valid - boolean признак валидности зависимости true - валидна false - не валидна parentId - String идентификатор родительского мероприятия Пример: { "settings": { "calcType": 0, "progressCalcType": 0, "progressRecalculation": false, "actionWeightField": null, "datesType": 0, "progressType": 1 }, "id": "dd081e05-7a2c-454b-9972-441fd465704a", "name": "example", "code": "example", "visible": true, "risks": [ { "riskID": null, "riskName": "example_risk", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": null, "deleted": null, "authorInfo": { "userID": "1", "userName": null }, "resUserInfo": { "userID": null, "userName": null }, "probability": 13, "impact": 50, "description": "Мероприятия по риску", "statusID": 3, "status": "Проводятся мероприятия", "typeID": "inst", "typeName": "Институциональные риски" }, { "riskID": "a2c32707-8a1b-4fba-8609-ca54adb554db", "riskName": "dsfdfsdf", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": "2015-08-12T00:00:00.000+0600", "deleted": "2015-08-12T11:12:08.076+0600", "authorInfo": { "userID": "0a9eb338-9176-4ae3-8f0f-c3800f5685d9", "userName": "Иванов И." }, "resUserInfo": { "userID": null, "userName": "" }, "probability": 13, "impact": 50, "description": "Описание мероприятий по риску", "statusID": 2, "status": "Запланирован", "typeID": "inst", "typeName": "Институциональные риски" } ], "fields": [ "length", "start_date", "finish_date", "depends_on", "responsible", "percent" ], "actions": [ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [] }, "name": "example", "duration": 1, "links": null, "parentId": null } ] } |
public java.lang.String saveLink(java.lang.String structNumber, java.lang.String link, java.lang.String locale)
public java.util.List<PlanTemplate> list(ProjectTemplateSearchParams params)
ProjectTemplateService
ProjectTemplateService.get(String)
{ "ascending": true, "search": "тест", "pageNumber": 0, "countInPart": 30 }
list
in interface ProjectTemplateService
params
- параметры поискаpublic PlanTemplate get(java.lang.String id)
ProjectTemplateService
ProjectTemplateService.saveTemplate(String, PlanTemplate)
, за исключением рисков и
отображаемых полей, которые null.
get
in interface ProjectTemplateService
id
- id шаблонаProjectTemplateService.saveTemplate(String, PlanTemplate)
, за исключением рисков и
отображаемых полей, которые null.public <any> saveTemplate(java.lang.String id, PlanTemplate template)
ProjectTemplateService
{ "settings": { "calcType": 0, "progressCalcType": 0, "progressRecalculation": false, "actionWeightField": null, "datesType": 0, "progressType": 1 }, "id": "dd081e05-7a2c-454b-9972-441fd465704a", "name": "example", "code": "example", "visible": true, "risks": [ { "riskID": null, "riskName": "example_risk", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": null, "deleted": null, "authorInfo": { "userID": "1", "userName": null }, "resUserInfo": { "userID": null, "userName": null }, "probability": 13, "impact": 50, "description": "Мероприятия по риску", "statusID": 3, "status": "Проводятся мероприятия", "typeID": "inst", "typeName": "Институциональные риски" }, { "riskID": "a2c32707-8a1b-4fba-8609-ca54adb554db", "riskName": "dsfdfsdf", "planID": "dd081e05-7a2c-454b-9972-441fd465704a", "enterDate": "2015-08-12T00:00:00.000+0600", "deleted": "2015-08-12T11:12:08.076+0600", "authorInfo": { "userID": "0a9eb338-9176-4ae3-8f0f-c3800f5685d9", "userName": "Иванов И." }, "resUserInfo": { "userID": null, "userName": "" }, "probability": 13, "impact": 50, "description": "Описание мероприятий по риску", "statusID": 2, "status": "Запланирован", "typeID": "inst", "typeName": "Институциональные риски" } ], "fields": [ "length", "start_date", "finish_date", "depends_on", "responsible", "percent" ], "actions": [ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [] }, "name": "example", "duration": 1, "links": null, "parentId": null } ] }
saveTemplate
in interface ProjectTemplateService
public void changeVisibility(java.lang.String id, boolean visible)
ProjectTemplateService
changeVisibility
in interface ProjectTemplateService
id
- - идентификатор шаблонаvisible
- - видимость. Возможные варианты: true - видимый, false - скрытыйpublic <any> newTemplate(PlanTemplate template)
ProjectTemplateService
ProjectTemplateService.saveTemplate(String, PlanTemplate)
,
но id шаблона должно быть null.
Возвращает JSON шаблона проектов, описанный в ProjectTemplateService.get(String)
newTemplate
in interface ProjectTemplateService
template
- - новый шаблонpublic java.lang.Integer getTemplatePages(int countInPart, java.lang.String search)
ProjectTemplateService
getTemplatePages
in interface ProjectTemplateService
countInPart
- количество элементов на страницеsearch
- строка поискаpublic java.util.List<PlanTemplateAction> getActions(java.lang.String templateId)
ProjectTemplateService
getActions
in interface ProjectTemplateService
templateId
- id шаблона[ { "id": "13e88fd9-9225-4f9d-8e54-c8cde0596774", "structNumber": { "numbers": [1,2,3] }, "name": "example", "duration": 1, "links": null, "parentId": null } ]
public java.util.List<PlanTemplateName> getTemplateNames()
ProjectTemplateService
getTemplateNames
in interface ProjectTemplateService
[ { "name": "1000005", "id": "1a8ce533-57c9-47fb-b102-fc60d4ab5a32", "code": "hgsudshguopsdjg" }, { "name": "1000005", "id": "ad20fc0c-0202-4e85-8d5c-ba5d67100d97", "code": "1000005" }, { "name": "1000010", "id": "1bc126a4-b56d-4598-84f3-445da8fd3bdf", "code": "1000010" }, { "name": "100006", "id": "0c151228-8e24-4eb9-bda5-773a054c4e5a", "code": "100006" } ]
public java.util.Set<java.lang.String> filterDictionaryItems(java.util.Set<java.lang.String> idsToFilter)
ProjectTemplateService
arta.synergy.common.mbo.actions.ActionsIF#filterWorkResultDicItems(Set)
filterDictionaryItems
in interface ProjectTemplateService
public <any> getTemplateForm(java.lang.String actionId)
ProjectTemplateService
arta.synergy.common.mbo.actions.ActionsIF#getProjectTemplate(String)
getTemplateForm
in interface ProjectTemplateService
public class ProjectService
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PORTFOLIO |
static java.lang.String |
PROJECT |
Constructor and Description |
---|
ProjectService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
assignActionResponsible(java.util.List<java.lang.String> userID,
java.lang.String actionID,
java.lang.String locale)
Назначение ответственных за мероприятие проекта
URL: rest/api/projects/assign_action_responsible
Type: POST |
java.lang.String |
createArrangement(java.lang.String name,
double costFact,
double costExpected,
java.lang.String groupID,
boolean veha,
java.lang.String startDate,
java.lang.String finishDate,
double length,
int workloadType,
double workloadValue,
java.lang.String locale)
Метод создает мероприятие для указанного проекта
URL: rest/api/projects/create_arrangement
Method: POST
|
java.lang.String |
createProject(java.lang.String name,
java.lang.String code,
double costFact,
double costExpected,
java.lang.String parentItemID,
java.lang.String startDate,
java.lang.String finishDate,
double length,
int workloadType,
double workloadValue,
java.lang.String locale)
Метод создает проект для указанного портфеля
URL: rest/api/projects/create_project
Method: POST
|
java.lang.String |
editArrangement(java.lang.String name,
double costFact,
double costExpected,
java.lang.String actionID,
java.lang.String groupID,
java.lang.String startDate,
java.lang.String finishDate,
double length,
int workloadType,
double workloadValue,
java.lang.String locale)
Метод изменяет существующее мероприятие
URL: rest/api/projects/edit_arrangement
Method: POST
|
java.lang.String |
editPointers(java.lang.String items,
java.lang.String actionID,
java.lang.String locale)
Метод изменяет значения дополнительных полей у мероприятия
URL: rest/api/projects/edit_pointer
Method: POST
Пример параметра items:
[
{
"pointerID": "f32c8441-cc25-4a0e-a885-35f0c74bc530",
"value": "test 1"
},
{
"pointerID": "58116c2f-e017-4ba6-afb6-bd8cb7834232",
"value": "test 2"
}
]
Пример успешного ответа
{
"errorCode": "0",
"errorMessage": "Successful"
}
|
java.lang.String |
editProject(java.lang.String name,
java.lang.String code,
java.lang.String actionID,
java.lang.String parentItemID,
double costFact,
double costExpected,
java.lang.String startDate,
java.lang.String finishDate,
double length,
int workloadType,
double workloadValue,
java.lang.String locale)
Метод предназначен для редактирования проекта
URL: rest/api/projects/edit_project
Method: POST
|
Response |
findProjectByName(java.lang.String search,
java.lang.String folderType,
java.lang.String locale) |
java.util.List<InnerAction> |
getActionsInfo(ActionsList aList)
метод для получения сроков и процента мероприятий
|
java.lang.String |
getAf(java.lang.String actionID,
java.lang.String type,
java.lang.String locale) |
Response |
getAllActionsOfProject(java.lang.String actionID,
java.lang.String locale)
Получение прогресса/сроков мероприятий проекта
URL: rest/api/projects/get_project_actions
Type: GET |
java.lang.String |
getArrangements(java.lang.String actionID,
boolean child,
java.lang.String locale) |
java.lang.String |
getPlanFolder(java.lang.String actionID,
java.lang.String locale) |
java.lang.String |
getProjectTree(java.lang.String itemID,
java.lang.String folderType,
boolean onlyFolders,
java.lang.String locale) |
Response |
getProjectTreeItemInfo(java.lang.String actionID,
java.lang.String locale)
получение информации о проекте или портфеле
|
java.lang.String |
getUserID() |
java.lang.String |
getWorkLoads(java.lang.String locale)
Метод возвращает описание нагрузок в системе
URL: rest/api/projects/get_work_loads
Method: GET
|
java.lang.String |
removeAf(java.lang.String actionID,
java.util.List<java.lang.String> fieldID,
java.util.List<java.lang.String> code,
java.lang.String type,
java.lang.String locale) |
java.lang.String |
setAf(java.lang.String actionID,
java.util.List<java.lang.String> fieldID,
java.util.List<java.lang.String> code,
java.lang.String type,
java.lang.String locale) |
public static final java.lang.String PROJECT
public static final java.lang.String PORTFOLIO
public Response findProjectByName(java.lang.String search, java.lang.String folderType, java.lang.String locale)
public Response getAllActionsOfProject(java.lang.String actionID, java.lang.String locale)
actionID
- - ид проектаlocale
- - локальpublic java.util.List<InnerAction> getActionsInfo(ActionsList aList)
aList
- - объект класса ActionList, откуда мы берем все мероприятия проектаpublic java.lang.String getPlanFolder(java.lang.String actionID, java.lang.String locale)
public java.lang.String assignActionResponsible(java.util.List<java.lang.String> userID, java.lang.String actionID, java.lang.String locale)
userID
- - список идентификаторов ответственныхactionID
- - идентификатор мероприятияlocale
- - локальpublic java.lang.String getProjectTree(java.lang.String itemID, java.lang.String folderType, boolean onlyFolders, java.lang.String locale)
public Response getProjectTreeItemInfo(java.lang.String actionID, java.lang.String locale)
actionID
- идентификатор элементаlocale
- локальpublic java.lang.String getUserID()
public java.lang.String createProject(java.lang.String name, java.lang.String code, double costFact, double costExpected, java.lang.String parentItemID, java.lang.String startDate, java.lang.String finishDate, double length, int workloadType, double workloadValue, java.lang.String locale)
Метод создает проект для указанного портфеля
URL: rest/api/projects/create_project Method: POSTname
- название проектаcode
- код проектаcostFact
- плановая стоимость (double)costExpected
- фактическая стоимость (double)parentItemID
- itemID портфеля (для того, чтобы получить это значение - надо поработать с апи методом get_project_tree,
параметр будет называться - itemID)startDate
- дата начала (формат: "yyyy-MM-dd HH:mm:00")finishDate
- дата завершения (формат: "yyyy-MM-dd HH:mm:00") (нужна в том случае, если в конфигураторе в настройках проекта выбрано "Тип ввода дат мероприятий проекта" - "Абсолютный (начало и завершение)")length
- продолжительность (в днях)workloadType
- тип нагрузки (необходимо вызывать метод get_work_loads)workloadValue
- значение нагрузки (необходимо вызывать метод get_work_loads)locale
- локальpublic java.lang.String editProject(java.lang.String name, java.lang.String code, java.lang.String actionID, java.lang.String parentItemID, double costFact, double costExpected, java.lang.String startDate, java.lang.String finishDate, double length, int workloadType, double workloadValue, java.lang.String locale)
Метод предназначен для редактирования проекта
URL: rest/api/projects/edit_project Method: POSTname
- название проектаcode
- код проектаactionID
- actionID проектаcostFact
- плановая стоимость (double)costExpected
- фактическая стоимость (double)parentItemID
- itemID портфеля (для того, чтобы получить это значение - надо поработать с апи методом get_project_tree,
параметр будет называться - itemID)workloadType
- тип нагрузки (необходимо вызывать метод get_work_loads)workloadValue
- значение нагрузки (необходимо вызывать метод get_work_loads)startDate
- дата начала (формат: "yyyy-MM-dd HH:mm:00")finishDate
- дата завершения (формат: "yyyy-MM-dd HH:mm:00") (нужна в том случае, если в конфигураторе в настройках проекта выбрано "Тип ввода дат мероприятий проекта" - "Абсолютный (начало и завершение)")length
- продолжительность (в днях)locale
- локальpublic java.lang.String createArrangement(java.lang.String name, double costFact, double costExpected, java.lang.String groupID, boolean veha, java.lang.String startDate, java.lang.String finishDate, double length, int workloadType, double workloadValue, java.lang.String locale)
Метод создает мероприятие для указанного проекта
URL: rest/api/projects/create_arrangement Method: POSTname
- название мероприятияcostFact
- фактическая стоимость (double)costExpected
- плановая стоимость (double)groupID
- groupID - группа мероприятия (можно получить из метода get_project_tree (нужно получить список портфелей), параметр будет называться actionID)startDate
- дата начала (формат: "yyyy-MM-dd HH:mm:00")finishDate
- дата завершения (формат: "yyyy-MM-dd HH:mm:00")length
- продолжительность (в днях)veha
- мероприятие не имеющее длительности (true/false)workloadType
- тип нагрузки (необходимо вызывать метод get_work_loads)workloadValue
- значение нагрузки (необходимо вызывать метод get_work_loads)locale
- локальpublic java.lang.String editArrangement(java.lang.String name, double costFact, double costExpected, java.lang.String actionID, java.lang.String groupID, java.lang.String startDate, java.lang.String finishDate, double length, int workloadType, double workloadValue, java.lang.String locale)
Метод изменяет существующее мероприятие
URL: rest/api/projects/edit_arrangement Method: POSTname
- название мероприятияcostFact
- плановая стоимость (double)costExpected
- фактическая стоимость (double)actionID
- actionID мероприятияgroupID
- groupID мероприятияstartDate
- дата начала (формат: "yyyy-MM-dd HH:mm:00")finishDate
- дата завершения (формат: "yyyy-MM-dd HH:mm:00")length
- продолжительность (в днях)workloadType
- тип нагрузки (необходимо вызывать метод get_work_loads)workloadValue
- значение нагрузки (необходимо вызывать метод get_work_loads)locale
- локальpublic java.lang.String getArrangements(java.lang.String actionID, boolean child, java.lang.String locale)
public java.lang.String editPointers(java.lang.String items, java.lang.String actionID, java.lang.String locale)
Метод изменяет значения дополнительных полей у мероприятия
URL: rest/api/projects/edit_pointer Method: POST Пример параметра items: [ { "pointerID": "f32c8441-cc25-4a0e-a885-35f0c74bc530", "value": "test 1" }, { "pointerID": "58116c2f-e017-4ba6-afb6-bd8cb7834232", "value": "test 2" } ] Пример успешного ответа { "errorCode": "0", "errorMessage": "Successful" }locale
- локальitems
- поляactionID
- id мероприятияpublic java.lang.String getWorkLoads(java.lang.String locale)
Метод возвращает описание нагрузок в системе
URL: rest/api/projects/get_work_loads Method: GETlocale
- локальpublic java.lang.String getAf(java.lang.String actionID, java.lang.String type, java.lang.String locale)
public java.lang.String setAf(java.lang.String actionID, java.util.List<java.lang.String> fieldID, java.util.List<java.lang.String> code, java.lang.String type, java.lang.String locale)
public java.lang.String removeAf(java.lang.String actionID, java.util.List<java.lang.String> fieldID, java.util.List<java.lang.String> code, java.lang.String type, java.lang.String locale)
public class ImportConfigurationServlet
extends HttpServlet
Constructor and Description |
---|
ImportConfigurationServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doPost(HttpServletRequest req,
HttpServletResponse res)
Метод импорта конфигурации
URL rest/api/configuration (requires basic http authorization)
Method POST enctype/multipart Запрос должен содержать следующие параметры data файл который необходимо импортировать new_version создавать новую версию для объектов типа "форма" delete_child_objects Удалять все дочерние объекты при замене родительского delete_rights Удалять права при замене объектов locale локаль возвращаемых сообщений Возвращает: json следующего вида {"errorCode":0,"errorMessage":""} error_values : 0 - Импорт прошёл успешно 3 - Переданы некорректные параметры 2 - Недостаточно прав для импорта/не авторизован 13 - В списке подписей встречаются подписи, который нет в системе http error 400 - Переданы некорректные параметры http error 403 - Недостаточно прав для импорта/не авторизован http error 500 - в случае любой другой ошибки |
protected void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, java.io.IOException
Метод импорта конфигурации
URL rest/api/configuration (requires basic http authorization)
Method POST enctype/multipart
req
- - HttpServletRequestres
- - HttpServletResponseServletException
java.io.IOException
public class DictionaryService
extends java.lang.Object
Constructor and Description |
---|
DictionaryService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addRecord(DictionaryRecord record)
Добавляет запись справочника
URL rest/api/dictionary/record/add
Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": null, "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор записи справочника (в данном методе не используется) columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника |
java.lang.String |
editRecord(DictionaryRecord record)
Изменяет запись справочника
URL rest/api/dictionary/record/edit
Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор редактируемой записи справочника columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника |
Response |
editRecords(DictionaryRecord[] records)
Изменяет запись справочника
URL rest/api/dictionary/record/edit
Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] } , где dictCode - код справочника itemID - идентификатор редактируемой записи справочника columns - список столбцов справочника, где code - код столбца справочника value - значение столбца справочника valueKZ, valueRU, valueEN - локализованные значения столбца справочника |
java.util.Collection<DictionaryItem> |
findDictionaryItems(java.lang.String organizationRecordIdColumnId,
java.lang.String orgID) |
java.util.Dictionary |
getDictionaryByCode(java.lang.String fieldsDictionaryCode,
boolean loadItems) |
java.lang.String |
getDictionaryValues(java.lang.String locale,
java.lang.String dictionaryCode)
Возвращает информацию о справочнике по его коду: столбцы, значения
URL rest/api/dictionary/get_by_code
Method GET Метод возвращает json с полями: dictionary_code - код справочника dictionaryID - идентификатор справочника columns - список столбцов справочника items - список значений справочника Для каждого столбца (columns) передается: columnID идентификатор столбца code код столбца Для каждого значения (items) передаются: itemID - идентификатор значения values - список значений каждого столбца. |
java.lang.String |
getHost() |
java.lang.String |
getUserID() |
java.lang.String |
removeRecord(DictionaryRecord record)
Удаляет запись справочника
URL rest/api/dictionary/record/remove
Method POST Вызывать метод можно только от имени пользователя с ролью "Методолог" "Content-type" запроса должен быть "application/json; charset=utf-8" и в теле запроса JSON в следующем формате { "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", } , где dictCode - код справочника itemID - идентификатор удаляемой записи справочника |
java.lang.String |
saveItem(DictionaryItem item) |
java.lang.String |
saveTranslations(java.lang.String id,
java.lang.String nameId,
java.lang.String mapJS) |
Response |
updateDictionary(DictionaryDefinitionJson json) |
public java.lang.String getDictionaryValues(java.lang.String locale, java.lang.String dictionaryCode)
Возвращает информацию о справочнике по его коду: столбцы, значения
URL rest/api/dictionary/get_by_code{"dictionary_code" : "work_completion", "dictionaryID": "0b247762-f049-49e7-93e5-fa7c93a779d7", "columns": [ { "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940", "code": "form_type" }, { "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427", "code": "form_type_name" }, { "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded", "code": "is_result_free" }, { "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6", "code": "additional_params" } ], "items": [ { "itemID": "36826cf9-5da9-49bf-9b79-3e3f9c0873a1", "values": [ { "value": "child=true", "columnID": "3b359c6b-5f17-4324-a6c2-3a3bc2e400b6" }, { "value": "0", "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded" }, { "value": "2", "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940" }, { "value": "Документ", "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" , "translation": "Документ" } ] }, { "itemID": "55dad228-2653-47c2-898a-ad263c2e7def", "values": [ { "value": "0", "columnID": "9f7778ba-c3b9-4653-ba4e-560ddb800ded" }, { "value": "0", "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940" }, { "value": "Комментарий", "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" , "translation": "Комментарий" } ] }, { "itemID": "5a753b31-db44-4e56-b922-fabeb29502ff", "values": [ { "value": "1", "columnID": "27e8d020-5db5-4b05-a3e2-ba364453a940" }, { "value": "Файл", "columnID": "5b3ab9bc-ea13-4fce-a37c-a83298dee427" , "translation": "Файл" } ] } ]}
____________________________________________________________________________________________________________________________ |form_type |form_type_name | is_result_free |additional_params | Идентификатор значения | |2 |Документ |0 |child=true |36826cf9-5da9-49bf-9b79-3e3f9c0873a1 | |0 |Комментарий |0 | |55dad228-2653-47c2-898a-ad263c2e7def | |1 |Файл | | |5a753b31-db44-4e56-b922-fabeb29502ff | ____________________________________________________________________________________________________________________________
locale
- локаль пользователяdictionaryCode
- код справочникаpublic java.lang.String addRecord(DictionaryRecord record)
{ "dictCode": "apitest", "itemID": null, "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] }, где
code - код столбца справочника
value - значение столбца справочника
valueKZ, valueRU, valueEN - локализованные значения столбца справочника
record
- запись справочника в формате JSONpublic java.lang.String editRecord(DictionaryRecord record)
{ "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] }, где
code - код столбца справочника
value - значение столбца справочника
valueKZ, valueRU, valueEN - локализованные значения столбца справочника
record
- запись справочника в формате JSONpublic Response editRecords(DictionaryRecord[] records)
{ "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", "columns": [ { "code": "number", "value": "42", "valueKZ": null, "valueRU": null, "valueEN": null }, { "code": "field_name", "value": "Поле с переводами", "valueKZ": "казахский", "valueRU": "русский", "valueEN": "английский" }, { "code": "field_desc", "value": "Тест переводов", "valueKZ": null, "valueRU": null, "valueEN": null } ] }, где
code - код столбца справочника
value - значение столбца справочника
valueKZ, valueRU, valueEN - локализованные значения столбца справочника
record
- запись справочника в формате JSONpublic java.lang.String removeRecord(DictionaryRecord record)
{ "dictCode": "apitest", "itemID": "195af529-35ee-4bd7-a2b8-bcc04c731283", }, где
record
- запись справочника в формате JSONpublic java.lang.String getHost()
public java.lang.String getUserID()
public java.util.Collection<DictionaryItem> findDictionaryItems(java.lang.String organizationRecordIdColumnId, java.lang.String orgID)
public Response updateDictionary(DictionaryDefinitionJson json)
public java.lang.String saveItem(DictionaryItem item)
public java.lang.String saveTranslations(java.lang.String id, java.lang.String nameId, java.lang.String mapJS)
public java.util.Dictionary getDictionaryByCode(java.lang.String fieldsDictionaryCode, boolean loadItems)
public class DictionariesService
extends java.lang.Object
Constructor and Description |
---|
DictionariesService() |
Modifier and Type | Method and Description |
---|---|
Response |
getDictionariesList(boolean getHidden,
java.lang.String locale)
Получение списка справочников
URL rest/api/dictionaries
Method GET Метод принимает следующие входные параметры: |
Response |
getDictionaryInfo(java.lang.String code,
boolean getColumns,
boolean getItems,
java.lang.String locale)
Получение описания и/или записей справочника
URL rest/api/dictionaries/{code}
Method GET |
public Response getDictionariesList(boolean getHidden, java.lang.String locale)
Получение списка справочников
URL rest/api/dictionariesМетод принимает следующие входные параметры:
getHidden
- возвращать ли скрытые справочники, true/false (не обяз., по умолчанию false)locale
- код локали (не обяз., по умолчанию ru)Пример возвращаемого массива:
[ { "id": "eb77639e-60b8-4a50-8327-0482063e8935", "code": "resolution_work_types", "name": "Типы работ по резолюции", "comment": "Значения выпадающего списка типа работы при наложении резолюции" }, { "id": "467d3eac-252c-427e-bd27-ba8704587257", "code": "calendar_types", "name": "Назначения календаря", "comment": "Статусы сотрудников" }, { "id": "7b953be8-bddb-4ce4-bbfd-ae9548f69c7f", "code": "BookPointer", "name": "Уровень проведения тренингов", "comment": "" }, { "id": "a830ed90-1ef5-4829-b3a4-efa8d087ed6a", "code": "BookPointer2", "name": "Уровень корпоративного духа", "comment": "" }, { "id": "9b077c41-4efa-48ce-8ce9-af2fe6145e96", "code": "send_items", "name": "Пункты меню отправки", "comment": "Пункты меню отправки документа/работы" }, { "id": "f75e8f6a-7b5a-493b-946b-ac35a628624f", "code": "Vid_otpuska", "name": "Виды отпусков", "comment": "" }, { "id": "dfb986ca-6dd2-415f-9304-bfab19d6d4af", "code": "nazionalnost", "name": "Национальности", "comment": "" }, { "id": "a0b8ee66-2820-4fb7-991d-4723955ccef5", "code": "action_progress", "name": "Подписи прогресса поручений", "comment": "Подписи прогресса поручений" }, { "id": "2d7729d7-1230-4c1c-a952-ebb4cf65278a", "code": "resolution", "name": "Тексты резолюций", "comment": "Справочник стандартных текстов резолюций" }, { "id": "b08289f0-fd6b-4b3c-bc99-fae8d4296acb", "code": "obrazovanie", "name": "Образование", "comment": "" } ]
public Response getDictionaryInfo(java.lang.String code, boolean getColumns, boolean getItems, java.lang.String locale)
Получение описания и/или записей справочника
URL rest/api/dictionaries/{code}code
- код справочника.getColumns
- возвращать ли описание справочника, true/false (не обяз., по умолчанию true)getItems
- возвращать ли записи справочника, true/false (не обяз., по умолчанию true)locale
- код локали (не обяз., по умолчанию ru)Метод должен возвращать массив с параметрами:
Для каждого столбца справочника (columns) передается:
Для каждой записи справочника (items) передаются значения кода столбца, а внутри каждого столбца - непосредственно значения записи
Каждая запись из items определяется ключом, который соответствует значению идентификатора значения (поле id)
В свою очередь, внутри записи каждый вложенный массив определяется ключом, который соответствует значению кода столбца (поле code)
Пример возвращаемого массива{ "id": "eb77639e-60b8-4a50-8327-0482063e8935", "code": "send_items", "name": "Пункты меню отправки", "comment": "Пункты меню отправки документа/работы", "columns": { "item_number": { "id": "e5d3ce83-25d1-46ae-94f9-c33930fc1565", "code": "item_number", "name": "Порядковый номер", "comment": "Используется для задания порядка пунктов меню отправки", "translate": false }, "item_name": { "id": "03e23318-71ec-4ced-a54c-73affaf43079", "code": "item_name", "name": "Название пункта меню отправки", "comment": "Текст, который будет отображаться в соответствующем пункте меню", "translate": true }, "item_process": { "id": "27f3090b-0a57-4c1f-8343-c56e8d39117d", "code": "item_process", "name": "Действие, которое осуществляет пункт", "comment": "", "translate": false } }, "items": { "b7c8861f-37df-4fe4-9f67-4f1cb243b008": { "item_number": { "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008", "value": "3", "translation": null }, "item_name": { "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008", "value": "Перепоручить", "translation": "Перепоручить" }, "item_process": { "id": "b7c8861f-37df-4fe4-9f67-4f1cb243b008", "value": "assignment", "translation": null } }, "80c92a72-988f-422a-92b9-70cd37f15dbc": { "item_number": { "id": "80c92a72-988f-422a-92b9-70cd37f15dbc", "value": "6", "translation": null }, "item_name": { "id": "80c92a72-988f-422a-92b9-70cd37f15dbc", "value": "На утверждение", "translation": "На утверждение" }, "item_process": { "id": "80c92a72-988f-422a-92b9-70cd37f15dbc", "value": "approval", "translation": null } } } }
Альтернативный поток событий. Передан некорректный параметр code: справочника с таким кодом не существует. Сервер возвращает следующий ответ (с HTTP-кодом 200):
{ "errorCode": "13", "errorMessage": "Справочник с кодом %значение% не найден" }
public class RegistryService
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static Logger |
LOGGER1 |
Constructor and Description |
---|
RegistryService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
activateRegistryDocument(java.lang.String documentID,
java.lang.String dataUUID,
java.lang.String summary,
java.lang.String locale,
java.lang.String ignoreSignature)
Запускает событие "Активация" записи реестра (документа)
URL rest/api/registry/activate_doc Method GET |
Response |
countRegistryData(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String filterID,
java.lang.String filterCode,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String locale,
java.lang.String sortCmpID,
boolean sortDesc,
java.lang.String andCombineGroup,
boolean loadData,
boolean searchByTerm,
java.util.List<java.lang.String> statuses,
java.util.List<java.lang.String> fields)
ЕСЛИ ЗАПРОС ПРЕВЫШАЕТ 2048 СИМВОЛОВ - НУЖНО ИСПОЛЬЗОВАТЬ АНАЛОГИЧНЫЙ POST МЕТОД
Api позволяет выполнять операции сложения, среднего арифметического, минимального и максимального числа по записям реестра.
|
Response |
countRegistryDataPost(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String filterID,
java.lang.String filterCode,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String locale,
java.lang.String sortCmpID,
boolean sortDesc,
java.lang.String andCombineGroup,
boolean loadData,
boolean searchByTerm,
java.util.List<java.lang.String> statuses,
java.util.List<java.lang.String> fields)
Api позволяет выполнять операции сложения, среднего арифметического, минимального и максимального числа по записям реестра.
|
java.lang.String |
createCollectionRegistryDocument(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String locale,
int count)
Создает указанное количество новых документов по реестру
URL rest/api/registry/create_collection_doc Method GET |
java.lang.String |
createRegistryDocument(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String locale,
boolean wasOpened)
Создает новый документ по реестру
URL rest/api/registry/create_doc Method GET Пример использования можно посмотреть в классе kz.arta.synergy.rest.api.sample.registry.CreateAndFillDocExample |
Response |
createRegistryDocumentWithRCC(CreateRegistryDocumentOperation operation) |
Response |
deleteCentralFilter(java.lang.String registryCode,
java.lang.String filterCode,
java.lang.String locale) |
java.lang.String |
deleteRegistryDocument(java.lang.String documentID,
java.lang.String dataUUID,
java.lang.String locale)
Запускает событие "Удаление" записи реестра (документа)
URL rest/api/registry/delete_doc Method GET |
Response |
deleteUserFilter(java.lang.String filterID,
java.lang.String locale) |
java.lang.String |
getFavorite(boolean bookmarks,
boolean mobile,
java.lang.String locale)
Метод возвращает список документов для окошка "Избранное"
URL: rest/api/registry/favorite Тип GET |
java.util.List<RegistryFilterJson> |
getFilterTree(java.lang.String parentID,
java.util.List<RegisterFilter> filters,
java.lang.String locale,
boolean loadIcon,
boolean loadConditions) |
java.lang.String |
getRegistry(java.lang.String registryID,
java.lang.String code,
java.lang.String user,
java.lang.String locale)
Получение данных о реестре
URL rest/api/registry/info
|
Response |
getRegistryCollations(java.lang.String registryCode,
java.lang.String collatedRegistryCode)
Возвращает полную информацию о сопоставлении между двумя указанными реестрами
URL: rest/api/registry/collation_info
Тип: GET
|
Response |
getRegistryData(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String user,
java.lang.String filterID,
java.lang.String filterCode,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String sortCmpID,
boolean sortDesc)
Получение записей реестра
|
Response |
getRegistryDataExt(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String filterID,
java.lang.String filterCode,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String locale,
java.lang.String sortCmpID,
boolean sortDesc,
java.lang.String andCombineGroup,
boolean loadData,
boolean searchByTerm,
java.util.List<java.lang.String> statuses,
java.util.List<java.lang.String> fields)
расширенный метод получения записей реестра
URL rest/api/registry/data_ext
Method GET Параметры поиска включают: registryID - идентификатор реестра (можно не указывать, если указан код) registryCode - код реестра (можно не указывать если указан идентификатор) filterID - идентификатор фильтра (не обязательное). |
Response |
getRegistryDataExtPost(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String filterID,
java.lang.String filterCode,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String locale,
java.lang.String sortCmpID,
boolean sortDesc,
java.lang.String andCombineGroup,
boolean loadData,
boolean searchByTerm,
java.util.List<java.lang.String> statuses,
java.util.List<java.lang.String> fields)
расширенный метод получения записей реестра
URL rest/api/registry/data_ext_post
Method POST Параметры поиска включают: registryID - идентификатор реестра (можно не указывать, если указан код) registryCode - код реестра (можно не указывать если указан идентификатор) filterID - идентификатор фильтра (не обязательное). |
Response |
getRegistryFilterItem(java.lang.String filterID,
java.lang.String locale) |
Response |
getRegistryFilters(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String type,
java.lang.String locale,
java.lang.String getIcon)
Получение фильтров реестра вместе с правами авторизованного пользователя и условиями фильтра
Тип: GET
URL: rest/api/registry/filters
|
Response |
getRegistryList(java.lang.String regGroupID,
java.lang.String locale)
Получение списка доступных пользователю реестров
URL rest/api/registry/list
Method GET Метод возвращает группы реестров и реестры в виде дерева (в соответствии с навигатором), а также список прав пользователя на данные реестры. |
Response |
getRegistryListWifthFilters(java.lang.String regGroupID,
java.lang.String locale) |
java.lang.String |
getRoute(java.lang.String registryID,
java.lang.String registryCode,
java.lang.String type,
java.lang.String locale) |
java.lang.String |
getUserID() |
Response |
loadRegistryList(java.lang.String regGroupID,
java.lang.String locale,
java.lang.Boolean includeFilters) |
java.lang.String |
modifyRegistryDocument(java.lang.String documentID,
java.lang.String dataUUID,
java.lang.String summary,
java.lang.String locale)
Запускает событие "Изменение" записи реестра (документа)
URL rest/api/registry/modify_doc Method GET |
<any> |
parseMetaItem(<any> metaItem,
DateFormat fm) |
java.lang.String |
registriesSearch(RegistryFileSearch searchParam)
Поиск файлов в реестрах
Тип: POST
URL: rest/api/registry/files/search
|
Response |
restoreRegistryDocument(java.lang.String documentId)
Данный метод восстанавливает документ, идентификатор которого введен в запросе.
|
Response |
saveOrEditCentralFilter(RegistryCentralFilterDTO registryCentralFilterDTO,
java.lang.String locale) |
Response |
saveOrEditUserFilter(RegistryCentralFilterDTO registryCentralFilterDTO) |
java.lang.String |
searchFavorite(int start,
java.lang.String search)
Метод используется для поиска избранных реестров
URL: rest/api/registry/search_favorite Тип GET |
java.lang.String |
setBookmark(java.lang.String itemID,
boolean bookmark,
java.lang.String locale)
Метод устанавливет реестр как "Избранный", либо наоборот
URL: rest/api/registry/set_bookmark Тип GET |
java.lang.String |
startRoute(java.lang.String registryID,
java.lang.String documentID,
java.lang.String subject,
java.lang.String dataUUID,
java.lang.String data,
java.lang.String type,
java.lang.String locale)
Метод запускает маршрут
>URL: rest/api/registry/route/start Тип POST |
public java.lang.String createRegistryDocument(java.lang.String registryID, java.lang.String registryCode, java.lang.String locale, boolean wasOpened)
registryID
- UUID реестра (параметр обязателен если не передан код реестра)registryCode
- код реестра (параметр обязателен если не передан UUID реестра)wasOpened
- был ли документ ранее открыт. Не обязательный, по умолчанию - false. Определяет вид документа при первом открытии в клиенте.locale
- локаль пользователяpublic Response createRegistryDocumentWithRCC(CreateRegistryDocumentOperation operation)
public java.lang.String createCollectionRegistryDocument(java.lang.String registryID, java.lang.String registryCode, java.lang.String locale, int count)
registryID
- UUID реестра (параметр обязателен если не передан код реестра)registryCode
- Код реестра (параметр обязателен если не передан UUID реестра)locale
- локаль пользователяcount
- количество записейpublic java.lang.String activateRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String summary, java.lang.String locale, java.lang.String ignoreSignature)
documentID
- идентификатор документа (необязательный)dataUUID
- идентификатор файла по форме (необязательный)locale
- локаль пользователяsummary
- краткое изложение маршрутаЗапись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.
Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. Для реестра задано событие активации записи и маршрут этого события содержит предварительные или последующие этапы.
public java.lang.String modifyRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String summary, java.lang.String locale)
documentID
- идентификатор документа (необязательный)dataUUID
- идентификатор файла по форме (необязательный)locale
- локаль пользователяsummary
- краткое изложение маршрутаЗапись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.
Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. Для реестра задано событие изменения записи и маршрут этого события содержит предварительные или последующие этапы.
public Response restoreRegistryDocument(java.lang.String documentId)
documentId
- идентификатор документа (необязательный)public java.lang.String deleteRegistryDocument(java.lang.String documentID, java.lang.String dataUUID, java.lang.String locale)
documentID
- идентификатор документа (необязательный)dataUUID
- идентификатор файла по форме (необязательный)locale
- локаль пользователяЗапись реестра может быть найдена как по идентификатору документа (параметр documentID), так и по идентификатору данных по форме (параметр dataUUID). Хотя бы один из этих параметров должен быть указан, если указаны оба, то будет произведена проверка что указанные идентификаторы относятся к одной записи реестра.
Возможные причины возврата ошибки
1. Запись реестра (документ) не найдена
2. У пользователя нет прав на удаление записей реестра
3. Запись реестра находится в неактивном состоянии (черновик)
4. Для реестра задано событие удаления записи и маршрут этого события содержит предварительные или последующие этапы.
public java.lang.String getFavorite(boolean bookmarks, boolean mobile, java.lang.String locale)
bookmarks
- true - отображать только избранные, false (по умолчанию) - отображать всеlocale
- локальmobile
- true - возвращать реестры, содержащие формы только с мобильным представлением, false - все (по умолчанию)[ { "itemID": "8049c154-7d19-4cb3-8f9e-013de869525c", "group": "true", "name": "Группа 1" }, { "itemID": "d4176542-e76d-41c9-9278-1a06d317d687", "group": "true", "name": "Группа 2" }, { "itemID": "fafe269c-0871-4697-85c5-1c473b48c0b5", "group": "false", "isBookmark" : "true" "registryID": "30ab9d73-95dc-4281-9326-47ac05837838", "formID": "dec6966f-6002-49ac-8013-b55f3c21763a", "formName": "api-test-form", "name": "Пункт 1" } ]Элемент может являться либо группой, либо пунктом. Если group = true, это значит, то данный элемент является группой, иначе - пункт. Для группы сервер возвращает параметры: itemID - uuid пункта group - группа или нет name - имя группы parentID - uuid родителя (если есть) Для пункта сервер возвращает параметры: itemID - uuid пункта group - группа или нет name - имя группы registryID - uuid реестра formID - uuid формы formName - имя формы isBookmark - является ли элемент текущий пункт избранным parentID - uuid родителя (если есть)
public java.lang.String searchFavorite(int start, java.lang.String search)
start
- позиция с которой начинается поиск (для первого поиска передавать не надо)search
- строка поискаpublic java.lang.String setBookmark(java.lang.String itemID, boolean bookmark, java.lang.String locale)
itemID
- itemID пунктаbookmark
- сделать пункт "избранным" - true, убрать "избранность" - falselocale
- локальpublic java.lang.String getRoute(java.lang.String registryID, java.lang.String registryCode, java.lang.String type, java.lang.String locale)
public java.lang.String startRoute(java.lang.String registryID, java.lang.String documentID, java.lang.String subject, java.lang.String dataUUID, java.lang.String data, java.lang.String type, java.lang.String locale)
registryID
- идентификатор реестраdocumentID
- идентификатор документаsubject
- имя документаdataUUID
- идентификатор данных по формеdata
- данные о маршруте (см. ниже)type
- тип события (ACTIVATE - активация, CHANGE - изменение, DELETE - удаление)locale
- локаль{ "before": { "routeID": "cf9f8a9a-1ccc-4327-b829-a71e472d393e", "items": [ { "itemID": "7b097e72-e303-487f-83a1-cb76397abd57", "code": "", "users": [ { "name": "1", "itemID": "7b097e72-e303-487f-83a1-cb76397abd57", "typeID": "ASSIGNMENT_ITEM", "userID": "ecb06f77-7ad7-4f54-9479-18fe932be337", "length": "8.0", "lengthType": "HOURS", "workloadValue": "50.0", "workLoadType": "PERCENT", "returnNumber": "", "completionFormID": "", "completionFormCode": "" }, { "name": "2", "itemID": "7b097e72-e303-487f-83a1-cb76397abd57", "typeID": "ASSIGNMENT_ITEM", "userID": "ecb06f77-7ad7-4f54-9479-18fe932be337", "length": "8.0", "lengthType": "HOURS", "workloadValue": "50.0", "workLoadType": "PERCENT", "returnNumber": "", "completionFormID": "", "completionFormCode": "" } ] }, { "itemID": "dc890ecf-e340-4ada-b7e6-d6541486a599", "code": "", "users": [ { "name": "3", "itemID": "dc890ecf-e340-4ada-b7e6-d6541486a599", "typeID": "AGREEMENT_ITEM", "userID": "ecb06f77-7ad7-4f54-9479-18fe932be337", "length": "8.0", "lengthType": "HOURS", "workloadValue": "50.0", "workLoadType": "PERCENT", "returnNumber": "", "completionFormID": "", "completionFormCode": "" }, { "name": "4", "itemID": "dc890ecf-e340-4ada-b7e6-d6541486a599", "typeID": "AGREEMENT_ITEM", "userID": "ecb06f77-7ad7-4f54-9479-18fe932be337", "length": "8.0", "lengthType": "HOURS", "workloadValue": "50.0", "workLoadType": "PERCENT", "returnNumber": "", "completionFormID": "", "completionFormCode": "" } ] } ] }, "after": { "routeID": "", "items": [] } } Где: before - описание предварительных этапов after - описание последующих этапов Каждое из этих полей, в свою, очередь состоит из: routeID - UUID данной части маршрута items - описание этапов данной части маршрута: itemID - UUID этапа code - код этапа users - описание подэтапов данного этапа: name - название подэтапа itemID - UUID подэтапа typeID - тип операции, один из следующих вариантов: ASSIGNMENT_ITEM - работа AGREEMENT_ITEM - согласование APPROVAL_ITEM - утверждение ACQUAINTANCE_ITEM - ознакомление RESOLUTION_ACTION - резолюция SEND_DOCUMENT - отправка документа BLOCKING_PROCESS - блокирующий процесс REGISTRATION_ITEM - регистрация ROUTE_ITEM - маршрут userID - ответственный за подэтап length - значение длительности подэтапа lengthType - тип длительности, один из следующих вариантов: HOURS - длительность в рабочих часах DAYS - длителность в рабочих днях DATE - дата завершения в формате `yyyy-MM-dd`; workloadValue - значение нагрузки подэтапа workLoadType - тип нагрузки, один из следующих вариантов: PERCENT - % рабочего времени HOURS_A_DAY - количество часов в день HOURS - общее количество рабочих часов DAYS - общее количество рабочих дней returnNumber - номер этапа возврата completionFormID - UUID формы завершения при наличии, либо пусто ( можно указывать либо данный параметр либо параметр completionFormCode, при этом если передаются оба поля, то completionFormCode в приоритете) completionFormCode - код формы завершения при наличии, либо пусто ( можно указывать либо данный параметр либо параметр completionFormID, при этом если передаются оба поля, то completionFormCode в приоритете) routeID - UUID маршрута (актуален только для типа "Маршрут")
RegistryConsts.ACTIVATE
,
RegistryConsts.CHANGE
,
RegistryConsts.DELETE
public java.lang.String getUserID()
public Response getRegistryData(java.lang.String registryID, java.lang.String registryCode, java.lang.String user, java.lang.String filterID, java.lang.String filterCode, java.lang.String searchString, int pageNumber, int countInPart, java.lang.String sortCmpID, boolean sortDesc)
registryID
- ид реестраregistryCode
- код реестра (можно не указывать если указан идентификатор)filterID
- ID фильтра (не обязательное). Если параметр не указан, то выполняется поиск по всему реестру.filterCode
- код фильтра (не обязательное, если указан filterID).user
- пользователь, получающий записи реестра (Параметр user не может быть использован)searchString
- строка поиска записей реестраpageNumber
- номер страницыcountInPart
- количество записей на страницеsortCmpID
- идентификатор столбца(компонента) по которому будет происходить сортировкаsortDesc
- обратная сортировка, работает всвязке с sortCmpIDpublic Response countRegistryData(java.lang.String registryID, java.lang.String registryCode, java.lang.String filterID, java.lang.String filterCode, java.lang.String searchString, int pageNumber, int countInPart, java.lang.String locale, java.lang.String sortCmpID, boolean sortDesc, java.lang.String andCombineGroup, boolean loadData, boolean searchByTerm, java.util.List<java.lang.String> statuses, java.util.List<java.lang.String> fields)
registryID
- - id реестраregistryCode
- - код реестраfilterID
- - id фильтраfilterCode
- - код фильтраsearchString
- - поисковая строкаpageNumber
- - номер страницыcountInPart
- - количество данных за разlocale
- - локальsortCmpID
- sortDesc
- andCombineGroup
- loadData
- statuses
- fields
- - все поля, которые записаны в fieldCode, необходимо передать в параметр fields через запятую.
Для каждого fieldCode должен быть свой countType. Если нужно считать по нескольким полям формы, сделать:
?fieldCode=[field_code]&countType=[countType]&fieldCode1=[field_code1]&countType1=[countType1]&....2..3 и т.д.public Response countRegistryDataPost(java.lang.String registryID, java.lang.String registryCode, java.lang.String filterID, java.lang.String filterCode, java.lang.String searchString, int pageNumber, int countInPart, java.lang.String locale, java.lang.String sortCmpID, boolean sortDesc, java.lang.String andCombineGroup, boolean loadData, boolean searchByTerm, java.util.List<java.lang.String> statuses, java.util.List<java.lang.String> fields)
registryID
- - id реестраregistryCode
- - код реестраfilterID
- - id фильтраfilterCode
- - код фильтраsearchString
- - поисковая строкаpageNumber
- - номер страницыcountInPart
- - количество данных за разlocale
- - локальsortCmpID
- sortDesc
- andCombineGroup
- loadData
- statuses
- fields
- - все поля, которые записаны в fieldCode, необходимо передать в параметр fields через запятую.
Для каждого fieldCode должен быть свой countType. Если нужно считать по нескольким полям формы, сделать:
?fieldCode=[field_code]&countType=[countType]&fieldCode1=[field_code1]&countType1=[countType1]&....2..3 и т.д.public Response getRegistryDataExt(java.lang.String registryID, java.lang.String registryCode, java.lang.String filterID, java.lang.String filterCode, java.lang.String searchString, int pageNumber, int countInPart, java.lang.String locale, java.lang.String sortCmpID, boolean sortDesc, java.lang.String andCombineGroup, boolean loadData, boolean searchByTerm, java.util.List<java.lang.String> statuses, java.util.List<java.lang.String> fields)
{ "result": [ { "registryID": "идентификатор реестра", "dataUUID": "идентификатор данных по форме", "documentID": "идентификатор документа", "fieldValue": { "textbox": "текстовое значение поля textbox", "cmp-3hnrdp": "текстовое значение поля cmp-3hnrdp", ... }, "fieldKey": { "textbox": "ключ поля textbox", "cmp-3hnrdp": "ключ поля cmp-3hnrdp", ... }, "status": "STATE_SUCCESSFUL", "state": 2 }, .... ], "recordsCount": 31 }
{ "data": [ { "dataUUID": "479c99d6-0271-4063-82b6-0277fc22e263", "documentID": "ebcd6930-0222-11e6-9a58-3085a93a6496" }, ... ], "count": 31 }
public Response getRegistryList(java.lang.String regGroupID, java.lang.String locale)
[ { "regGroupID": "8862e0fb-d334-462b-a8e8-e83b4f4e8f58", "regGroupName": "Сервисы ДРТ", "consistOf": [ { "registryID": "c56b2970-d3d8-11e6-833d-001ef892a4ee", "registryName": "Feature Requests", "registryCode": "Feature_Requests", "rights": [ "rr_create", "rr_list", "rr_read", "rr_edit", "rr_modify", "rr_delete" ] }, { "registryID": "0112b29b-95ad-45fd-b5c3-317613b3ab46", "registryName": "Заявки в ДРТ", "registryCode": "Заявки_в_ДРТ", "rights": [ "rr_create", "rr_list", "rr_read", "rr_edit" ] } ] }, { "regGroupID": "4d8db8c0-d340-11e6-8212-001ef892a4ee", "regGroupName": "Приказы", "consistOf": [ { "regGroupID": "77c72a08-9851-4963-b36c-bee7fcf39b8f", "regGroupName": "Приказы по отпускам", "consistOf": [ { "registryID": "a6598ca6-ab62-4187-964e-576a2c7173fe", "registryName": "Приказ о трудовом отпуске", "registryCode": "prikaz_o_trudovom_otpuske", "rights": [ "rr_create", "rr_list", "rr_read", "rr_edit", "rr_delete" ] } ] }, { "regGroupID": "4cfb3cc0-d340-11e6-8212-001ef892a4ee", "regGroupName": "Приказы по приему на работу", "consistOf": [ { "registryID": "032af000-d30d-11e6-833d-001ef892a4e", "registryName": "Приказ о приеме на работу (ЦА)", "registryCode": "prikaz_o_prieme_na_rabotu_CA", "rights": [ "rr_create", "rr_list", "rr_read" ] } ] } ] }, { "registryID": "ba9e43e4-3a95-474a-90a4-36ba79a7d9f9", "registryName": "Уведомление о сроках итерации", "registryCode": "uvedomlenie_o_srokah_iteracii", "rights": [ "rr_list", "rr_read" ] } ]
public Response getRegistryListWifthFilters(java.lang.String regGroupID, java.lang.String locale)
public Response loadRegistryList(java.lang.String regGroupID, java.lang.String locale, java.lang.Boolean includeFilters) throws javax.naming.NamingException, java.sql.SQLException
javax.naming.NamingException
java.sql.SQLException
public Response getRegistryDataExtPost(java.lang.String registryID, java.lang.String registryCode, java.lang.String filterID, java.lang.String filterCode, java.lang.String searchString, int pageNumber, int countInPart, java.lang.String locale, java.lang.String sortCmpID, boolean sortDesc, java.lang.String andCombineGroup, boolean loadData, boolean searchByTerm, java.util.List<java.lang.String> statuses, java.util.List<java.lang.String> fields)
{ "result": [ { "registryID": "идентификатор реестра", "dataUUID": "идентификатор данных по форме", "documentID": "идентификатор документа", "fieldValue": { "textbox": "текстовое значение поля textbox", "cmp-3hnrdp": "текстовое значение поля cmp-3hnrdp", ... }, "fieldKey": { "textbox": "ключ поля textbox", "cmp-3hnrdp": "ключ поля cmp-3hnrdp", ... }, "status": "STATE_SUCCESSFUL", "state": 2 }, .... ], "recordsCount": 31 }
{ "data": [ { "dataUUID": "479c99d6-0271-4063-82b6-0277fc22e263", "documentID": "ebcd6930-0222-11e6-9a58-3085a93a6496" }, ... ], "count": 31 }
public java.lang.String getRegistry(java.lang.String registryID, java.lang.String code, java.lang.String user, java.lang.String locale)
registryID
- ид реестраcode
- код реестраuser
- пользователь, получающий данные о реестреpublic java.lang.String registriesSearch(RegistryFileSearch searchParam)
Поиск файлов в реестрах
Тип: POST
URL: rest/api/registry/files/search
searchParam
- параметры поиска
Все поля, кроме registries
- не обязательные и не учитываются при ограничениях поиска.
Список реестров не должен быть пуст и содержать идентификаторов, которые не являются идентификаторами
реестров.
Описание JSON:
registries
- массив UUID реестров, по которым должен осуществляться поиск (обяз.)contains
- строка, которая должна содержаться в искомых файлах (не обяз.)notContains
- строка, которая не должна содержаться в искомых файлах (не обяз.)sortType
- тип сортировки файлов (не обяз., по умолчанию 0), одна из констант:
0
- по релевантности1
- по дате2
- по популярностиmodifiedFrom
- начало периода последнего изменения в формате yyyy-MM-dd (не обяз.)modifiedTo
- завершение периода последнего изменения в формате yyyy-MM-dd (не обяз.)metadata
- массив объекто со свойствами, которыми должны обладать искомые файлы (не обяз.):
name
- код свойстваvalue
- значение свойства (для текстовых свойств)values
- массив из двух значений свойства (диапазон дат "от" и "до")categories
- массив идентификаторов классификаторов, которым должны принадлежать искомые файлы (не обяз.)firstResult
- номер первой записи для возвращаемых результатов выборки (не обяз., по умолчанию 0)maxResult
- количество записей, которые должны быть возвращены (не обяз., по умолчанию 30)locale
- локаль пользователя
{
"registries": ["7ce1feff-a3f0-4f4e-8bf6-59e37caf553f", "7b953be8-bddb-4ce4-bbfd-ae9548f69c7f"],
"contains": "Документ",
"notContains": "Работа",
"sortType": 2,
"modifiedFrom": "2016-01-01",
"modifiedTo": "2016-01-31",
"metadata": [
{
"name": "subject",
"value": "Тема"
},
{
"name": "date",
"values": ["2015-01-01", "2015-01-31"]
},
{
"name": "language",
"value": "Русский"
}
],
"categories": [1, 2, 3],
"firstResult": 1,
"maxResult": 3
}
count
- общее количество найденных записейlist
- список найденных файлов
identifier
- идентификатор файла
documentID
- идентификатор документа, которому файл принадлежит
uuid
- идентификатор данных по форме основной формы записи реестра
aiType
- тип файла
name
- название файла
path
- путь к файлу
iconUrl
- ссылка до иконки файла
{
"count": 10,
"list": [
{
"identifier": "3a170735-4fa3-4e2b-87ae-f346ace3487f",
"documentID": "0f3a99ac-a712-40ea-98fe-3642af96b860",
"uuid": "e871ad70-2c87-11e6-b39a-d238769c712c",
"ai_type": "ai_image",
"name": "Успешное проведение презентации.jpg",
"path": "Хранилище/Успешное проведение презентации.jpg",
"iconUrl": "rest/api/storage/icons/get?aiType=ai_image&fileName=Успешное проведение презентации.jpg"
},
{
"identifier": "bd523ca2-a2f5-4a8b-ace5-26b300628e32",
"documentID": "212af63f-597b-41a8-bbaf-6987d84651ac",
"uuid": "e871ad70-2c87-11e6-b39a-d238769c712c",
"ai_type": "ai_text",
"name": "Стратегическое планирование.doc",
"path": "Хранилище/Стратегическое планирование.doc",
"iconUrl": "rest/api/storage/icons/get?aiType=ai_text&fileName=Стратегическое планирование.doc"
},
{
"identifier": "d9fed65d-600f-4eae-bba8-78cbee46bc57",
"documentID": "5156cafe-8fd4-4e39-bb56-4014f42353a5",
"uuid": "1825899d-d7a5-4c0d-b42e-882a2ab0c3d0",
"ai_type": "ai_text",
"name": "Отраслевая программа.pdf",
"path": "Хранилище/Отраслевая программа.pdf",
"iconUrl": "rest/api/storage/icons/get?aiType=ai_text&fileName=Отраслевая программа.pdf"
},
{
"identifier": "dfsdf4546-600f-4eae-bba8-78cbee46bc57",
"documentID": "tfghfgh-545f-5fgg-hngfh-545c4f42353a5",
"uuid": "1855899d-d7a5-4c9d-b56e-998a2ab0c3c2",
"aiType": "ai_text",
"name": "Общая программа.pdf",
"path": "Хранилище/Общая программа.pdf",
"iconUrl": "rest/api/storage/icons/get?aiType=ai_text&fileName=Общая программа.pdf"
}
]
}
public Response getRegistryFilters(java.lang.String registryID, java.lang.String registryCode, java.lang.String type, java.lang.String locale, java.lang.String getIcon)
Получение фильтров реестра вместе с правами авторизованного пользователя и условиями фильтра
Тип: GET
URL: rest/api/registry/filters
registryID
- ID реестраregistryCode
- код реестраtype
- требуемые типы фильтров (не обязательное). Может принимать значения:
locale
- код локалиgetIcon
- возвращать иконку фильтра. По умолчанию принимает значение true.public Response getRegistryFilterItem(java.lang.String filterID, java.lang.String locale)
public Response saveOrEditUserFilter(RegistryCentralFilterDTO registryCentralFilterDTO)
public Response deleteUserFilter(java.lang.String filterID, java.lang.String locale)
public Response deleteCentralFilter(java.lang.String registryCode, java.lang.String filterCode, java.lang.String locale)
public Response saveOrEditCentralFilter(RegistryCentralFilterDTO registryCentralFilterDTO, java.lang.String locale)
public java.util.List<RegistryFilterJson> getFilterTree(java.lang.String parentID, java.util.List<RegisterFilter> filters, java.lang.String locale, boolean loadIcon, boolean loadConditions)
public <any> parseMetaItem(<any> metaItem, DateFormat fm)
public Response getRegistryCollations(java.lang.String registryCode, java.lang.String collatedRegistryCode)
Возвращает полную информацию о сопоставлении между двумя указанными реестрами
URL: rest/api/registry/collation_info
Тип: GET
registryCode
- код реестра, из которого производится сопоставлениеcollatedRegistryCode
- код реестра, в который производится сопоставлениеpublic class TranslationService extends java.lang.Object implements TranslationServiceIF
Constructor and Description |
---|
TranslationService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getLocale() |
java.lang.Integer |
getSearchObjectsSize(java.lang.String localeID,
java.lang.String searchString,
int entityType,
boolean notTranslated)
Получение размера возвращаемого результата при поиске
|
java.util.List<SynergyLocale> |
getSynergyLocales(boolean visible)
Получение языков находящихся в Synergy
|
EntityTranslation |
getTranslations(long translationID)
Получение переводов по id перевода
|
Translation |
getTranslationSize(int entityType,
boolean notTranslated)
Получение количества записей при запросе ресурсов
|
java.lang.Boolean |
removeTranslations(long translationID)
Удаление перевода сущности
|
java.lang.Boolean |
saveLocales(java.util.List<SynergyLocale> locales)
Сохранение локалей
|
java.lang.Boolean |
saveResourceTranslations(java.util.List<TranslationObject> translations)
Сохранение переводов сущностей и переводов сообшений, используется в редакторе ресурсов
|
java.lang.Long |
saveTranslations(EntityTranslation entityTranslation)
Сохранение переводов
|
java.util.List<TranslationObject> |
searchObjects(java.lang.String localeID,
java.lang.String searchString,
int start,
int length,
int entityType,
boolean notTranslated)
Поиск объектов соответствующий запросу частями
|
public java.util.List<SynergyLocale> getSynergyLocales(boolean visible)
TranslationServiceIF
getSynergyLocales
in interface TranslationServiceIF
visible
- - только видимыеpublic java.lang.Boolean saveLocales(java.util.List<SynergyLocale> locales)
TranslationServiceIF
saveLocales
in interface TranslationServiceIF
locales
- - список локалейpublic EntityTranslation getTranslations(long translationID)
TranslationServiceIF
getTranslations
in interface TranslationServiceIF
translationID
- - id переводаpublic java.lang.Long saveTranslations(EntityTranslation entityTranslation)
TranslationServiceIF
saveTranslations
in interface TranslationServiceIF
entityTranslation
- - переводыpublic Translation getTranslationSize(int entityType, boolean notTranslated)
TranslationServiceIF
getTranslationSize
in interface TranslationServiceIF
public java.lang.Boolean removeTranslations(long translationID)
TranslationServiceIF
removeTranslations
in interface TranslationServiceIF
translationID
- - id переводаpublic java.lang.Boolean saveResourceTranslations(java.util.List<TranslationObject> translations)
TranslationServiceIF
saveResourceTranslations
in interface TranslationServiceIF
translations
- - список объектов с переводамиpublic java.util.List<TranslationObject> searchObjects(java.lang.String localeID, java.lang.String searchString, int start, int length, int entityType, boolean notTranslated)
TranslationServiceIF
searchObjects
in interface TranslationServiceIF
localeID
- - локальsearchString
- - строка поиска, может быть пустой, тогда будет выборка из всех, нужно для выборки по типу и непереведенностиstart
- - откуда начинать выбиратьlength
- - сколько выбратьentityType
- - тип сущностиnotTranslated
- - выбирать только не переведенныеpublic java.lang.Integer getSearchObjectsSize(java.lang.String localeID, java.lang.String searchString, int entityType, boolean notTranslated)
TranslationServiceIF
getSearchObjectsSize
in interface TranslationServiceIF
localeID
- - локальsearchString
- - строка поиска, может быть пустой, тогда будет выборка из всех, нужно для выборки по типу и непереведенностиentityType
- - тип сущностиnotTranslated
- - выбирать только не переведенныеpublic java.lang.String getLocale()
public class UserChooserService
extends java.lang.Object
Constructor and Description |
---|
UserChooserService() |
Modifier and Type | Method and Description |
---|---|
Response |
addOftenChosenUsers(java.util.List<java.lang.String> users)
метод сохраняет последних выбранных пользователей для пользователя
>url: /rest/api/userchooser/addOftenUsers method: GET Parameters: userID - идентификатор пользователя (может повторяться) Возвращает json c полями errorCode, errorMessage, где - errorCode код ошибки (0, если ошибки нет) - errorMessage расшифровка ошибки (пустая строка, если ошибки нет) если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR |
Response |
checkDepartments(int pageNumber,
int countInPart,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterChildDepartmentID,
java.lang.String filterPositionID,
java.lang.String search,
boolean showChildDepartments,
java.lang.String filterHrUser,
java.util.List<java.lang.String> valuesToCheck,
java.lang.String filterUserID,
java.lang.String locale)
проверка подходят ли переданные департаменты под указанные параметры поиска
url: /rest/api/userchooser/checkDepartments
method : GET
startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска customFields не используется filterDepartmentID идентификатор непосредственного родительского подразделения filterChildDepartmentID идентификатор непосредственного родительского подразделения filterPositionID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать valuesToCheck проверяемые значения идентификаторов передается как valuesToCheck=identifier1&valuesToCheck=identifier2 |
Response |
checkPositions(int startRecord,
int recordsCount,
boolean showAll,
boolean showOnlyVacant,
java.lang.String locale,
java.lang.String userID,
java.lang.Integer operationType,
java.lang.String search,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterUserID,
java.util.List<java.lang.String> valuesToCheck)
проверка подходят ли переданные должности под переданные параметры выборки
|
Response |
checkUsers(java.lang.String locale,
boolean showAll,
int levelsCount,
int groupID,
java.lang.String search,
java.lang.Integer operationType,
java.lang.Integer ownerOperationType,
java.lang.String departmentID,
java.lang.String userID,
java.lang.String showNoPosition,
java.lang.String filterPositionID,
java.lang.String filterDepartmentID,
java.lang.String positionType,
java.util.List<java.lang.String> usersToCheck)
проверка подходят ли данные пользователи под указанные параметры
url: /rest/api/userchooser/search_ext method : GET locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя groupID идентификатор группы. |
Response |
getAllPositions(int startRecord,
int recordsCount,
boolean showOnlyVacant,
java.lang.String locale,
java.lang.String userID,
java.lang.String search,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterUserID)
получение списка должностей
url: /rest/api/userchooser/search_all_positions
method : GET
startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска showOnlyVacant - false по умолчанию, отображать только вакантные должности actorID пользователь от имени которого выполнять поиск filterDepartmentID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать |
Response |
getDepartments(int pageNumber,
int countInPart,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterChildDepartmentID,
java.lang.String filterPositionID,
java.lang.String search,
boolean showChildDepartments,
java.lang.String filterHrUser,
java.lang.String filterUserID,
java.lang.String locale)
получение списка департаментов
url: /rest/api/userchooser/search_dept
method : GET
Параметры:
locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть filterDepartmentID идентификатор непосредственного родительского подразделения filterChildDepartmentID идентификатор непосредственного родительского подразделения filterPositionID идентификатор непосредственного родительского подразделения search параметр текстового поиска Описание ответа: массив найденных должностей поля возвращаемой сущности departmentId -идентификатор департамента departmentName наименование hasChildren имеются ли дочерние подразделения parentName наименование родительского департамента если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR |
Response |
getDepartments(java.util.List<java.lang.String> departmentIDs,
java.lang.String locale)
получение информации о должностях
url: /rest/api/userchooser/getUserInfo method : GET |
Response |
getOftenChosenUsers(int startRecord,
int recordsCount,
java.lang.String locale,
boolean showAll,
java.lang.String search,
java.lang.Integer operationType,
java.lang.Integer ownerOperationType,
java.lang.String filterPositionID,
java.lang.String filterDepartmentID,
java.lang.Integer positionType,
java.util.List<java.lang.String> customFields,
java.lang.String userNameDisplayType)
получение списка часто выбираемых пользователей пользователей
url: /rest/api/userchooser/getOftenChosenUsers
method : GET
startRecord C какой записи поднимать пользователей recordsCount Какое кол-во записей поднимать locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи search Строка поиска operationType Тип действия Если данный параметр задан, то список пользователей будет подгружаться не только от имени actorID, но и от имени тех пользователей, которые делегировали ему право на operationType ownerOperationType Если данный параметр задан, то список пользователей в выборке ограничивается теми пользователями, которые делегировали actorID право на ownerOperationType и самим actorID filterPositionID UUID должности - фильтра. |
Response |
getOftenPositions(int startRecord,
int recordsCount,
boolean showAll,
boolean showOnlyVacant,
java.lang.String locale,
java.lang.String userID,
java.lang.Integer operationType,
java.lang.String search,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterUserID,
java.util.List<java.lang.String> customFields)
получение списка часто выбираемых должностей
url: /rest/api/userchooser/getOftenChosenPositions method : GET startRecord - по умолчанию 0 recordsCount - по умолчанию 30 showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности) showOnlyVacant - false по умолчанию, отображать только вакантные должности locale - локаль userID пользователь от имени которого выполнять поиск operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности) search параметр текстового поиска departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть filterDepartmentID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать customField не используется |
Response |
getPositions(int startRecord,
int recordsCount,
boolean showAll,
boolean showOnlyVacant,
java.lang.String locale,
java.lang.String userID,
java.lang.Integer operationType,
java.lang.String search,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterUserID,
java.util.List<java.lang.String> customFields)
получение списка должностей
url: /rest/api/userchooser/search_pos
startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности) showOnlyVacant - false по умолчанию, отображать только вакантные должности operationType - тип операции для получения пользователей которые делегировали права пользователю (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности) mode - по умолчанию 0(COMMON_MODE). |
Response |
getPositions(java.util.List<java.lang.String> positionIDs,
java.lang.String locale)
получение информации о должностях
url: /rest/api/userchooser/getUserInfo method : GET |
Response |
getUserCalendarStatus(java.lang.String userID,
java.lang.String date,
java.lang.String locale)
url: /rest/api/userchooser/getUserCalendarStatus method : GET userID идентификатор пользователя чьи статусы нам необходимо получить date дата в формате yyy-MM-dd locale локаль Пример запроса: `rest/api/userchooser/getUserCalendarStatus? |
java.lang.String |
getUserID() |
java.lang.String |
getUsers(int startRecord,
int recordsCount,
java.lang.String locale,
boolean showAll,
int levelsCount,
int groupID,
java.lang.String groupCode,
java.lang.String search,
java.lang.Integer operationType,
java.lang.Integer ownerOperationType,
java.lang.String departmentID,
java.lang.String userID)
Метод выполняет поиск пользователей
URL rest/api/userchooser/search
Method GET Для каждого пользователя возвращаются следующие данные userID - идентификатор пользователя name - имя пользователя в формате Фамилия И.О. |
Response |
getUsers(java.util.List<java.lang.String> userIDs,
java.lang.String locale)
получение информации о пользователях (группах, контактах)
url: /rest/api/userchooser/getUserInfo method : GET Описание ответа: массив объектов с информацией о пользователях departmentName наименование департамента firstname имя lastname фамилия patronymic отчество personID идентификатор пользователя personName имя пользователя positionName наименование должности customFields - свойства элемента, зависят от типа элемента (смотрите пункт про определение типа сущности по идентификатору) Определение типа сущности по идентификатору и доп поля этой сущности если userID начинается "g-" - группа (type - groupId, id - идентификатор группы, code - код группы) "contact-" - контакт (contactType - организация или человек, email - почта если есть, id - идентификатор контакта, type - contact, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса) "text-" - текст (type - text, text - true, calendarColor - цвет статуса, calendarStatusLabel - подпись статуса) иначе пользователь( type - person, id идентификатор пользователя, calendarType - тип календарного статуса, calendarStatus - статус, calendarColor - цвет статуса, calendarTitle - название статуса, calendarStatusLabel - подпись в чузере статуса, calendarStartDate - дата начала, calendarFinishDate - дата завершения если в процессе произошла ошибка метод возвращает http status 500 INTERNAL_SERVER_ERROR |
Response |
getUsersCalendarStatus(java.util.List<java.lang.String> users,
java.lang.String date,
java.lang.String locale)
url: /rest/api/userchooser/getUsersCalendarStatus method : GET Пример ответа: { "4bd1ef2e-3271-4dd3-ac67-9a8017abe1f4": { "type": 1, "status": "free", "color": "#fecebe", "title": "ОТПУСК!!!" |
Response |
getUsersExt(int startRecord,
int recordsCount,
java.lang.String locale,
boolean showAll,
int levelsCount,
int groupID,
java.lang.String groupCode,
java.lang.String search,
java.lang.Integer operationType,
java.lang.Integer ownerOperationType,
java.lang.String departmentID,
java.lang.String userID,
java.lang.String showNoPosition,
java.lang.String filterPositionID,
java.lang.String filterDepartmentID,
java.lang.String positionType,
java.util.List<java.lang.String> customFields,
java.lang.String userNameDisplayType,
boolean showEmailContacts,
boolean showGroups)
получение списка пользователей
url: /rest/api/userchooser/search_ext method : GET startRecord C какой записи поднимать пользователей recordsCount Какое кол-во записей поднимать locale локаль пользователя showAll Если значение переменной стоит true, то должны быть отображены не только подчиненные но и все пользователи levelsCount Количество уровней "вниз" по оргструктуре от данного пользователя groupID идентификатор группы. |
Response |
getUserStatusInPeriod(java.lang.String start,
java.lang.String finish,
java.lang.String type,
java.lang.String locale,
int startRecord,
int recordsCount,
java.lang.String sortByDate)
Апи получения пользователей с назначенным календарем
Метод возвращает список пользователей, назначенный период которых полностью или
частично попадает в указанный промежуток времени. |
public java.lang.String getUsers(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String groupCode, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID)
Метод выполняет поиск пользователей
URL rest/api/userchooser/searchrest/api/userchooser/search?showAll=false
rest/api/userchooser/search?showAll=true
rest/api/userchooser/search?showAll=true&userID=user1
rest/api/userchooser/search?showAll=true&search=абв
rest/api/userchooser/search?showAll=true&search=абв&departmentID=department1
rest/api/userchooser/search?showAll=false&operationType=101
rest/api/userchooser/search?showAll=true&ownerOperationType=101
public Response getUsersExt(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String groupCode, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID, java.lang.String showNoPosition, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.String positionType, java.util.List<java.lang.String> customFields, java.lang.String userNameDisplayType, boolean showEmailContacts, boolean showGroups)
public Response getUsers(java.util.List<java.lang.String> userIDs, java.lang.String locale)
userIDs
- идентификаторы пользователей передаются как userID=identifier1&userID=identifier2&userID=identifier3 (смотрите пункт про определение типа сущности по идентификатору)locale
- локальpublic Response getPositions(java.util.List<java.lang.String> positionIDs, java.lang.String locale)
positionIDs
- идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3locale
- public Response getDepartments(java.util.List<java.lang.String> departmentIDs, java.lang.String locale)
departmentIDs
- идентификаторы должностей передаются как positionID=identifier1&positionID=identifier2&positionID=identifier3locale
- public Response getUsersCalendarStatus(java.util.List<java.lang.String> users, java.lang.String date, java.lang.String locale)
{ "4bd1ef2e-3271-4dd3-ac67-9a8017abe1f4": { "type": 1, "status": "free", "color": "#fecebe", "title": "ОТПУСК!!!", "statusLabel": "отпуск", "startDate": 1456423200000, "finishDate": 1474480800000 }, "1": { "type": 1, "status": "free", "color": "#456789", "title": "Командировка", "statusLabel": "Командировка", "startDate": 1456423200000, "finishDate": 1474480800000 } }
users
- несколько пользователей userID=userid1&userID=userid2date
- дата в формате yyy-MM-ddlocale
- локальpublic Response getUserCalendarStatus(java.lang.String userID, java.lang.String date, java.lang.String locale)
public Response getUserStatusInPeriod(java.lang.String start, java.lang.String finish, java.lang.String type, java.lang.String locale, int startRecord, int recordsCount, java.lang.String sortByDate)
Апи получения пользователей с назначенным календарем
Метод возвращает список пользователей, назначенный период которых полностью илиstart
- дата начала периода, в формате `YYYY-MM-DD` (обяз.)finish
- дата завершения периода, в формате `YYYY-MM-DD` (обяз.);type
- тип назначенного статуса, соответствует полю type справочника
"Назначение календаря" c кодом calendar_types (необяз.). Если задан данный
параметр, то возвращаются пользователи, тип периода которых соответствует
указанному значению, может принимать только целые положительные значения;locale
- локаль;startRecord
- номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)recordsCount
- количество результатов, которое необходимо вернуть
(по умолчанию 30). Максимальное значение параметра 100sortByDate
- направление сортировки результатов по выходному параметру дате
начала периода start. Тип сортировки - дата. Принимает следующие значения (необяз.):
Примечание. Пользователь может возвращаться в списке результатов несколько раз, так как пользователю может быть назначено несколько статусов в разные периоды времени.
Для пользователя может быть несколько статусов в течение выбранного периода времениВ случае передачи неверных параметров или внутренней ошибки сервера будет
возвращен массив следующего содержания (сообщение об ошибке будет менятся):
{Код ответа для внутренней ошибки - HTTP 500(INTERNAL_SERVER_ERROR), для неверных параметров - HTTP 400(BAD_REQUEST)
"errorCode": 13,
"errorMessage": "Передан некорректный параметр start"
}
public Response checkUsers(java.lang.String locale, boolean showAll, int levelsCount, int groupID, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String departmentID, java.lang.String userID, java.lang.String showNoPosition, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.String positionType, java.util.List<java.lang.String> usersToCheck)
public Response checkPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> valuesToCheck)
startRecord
- первая позиция выборки (по умолчанию 0)recordsCount
- количество в выборке (по умолчанию 30)showAll
- показывать все должности, по умолчанию нет (если нет - то отображаются только подчиненные должности)showOnlyVacant
- отображать только вакантные должности, по умолчанию нетlocale
- локальuserID
- идентификатор пользователя от имени которого нужно выполнять поискoperationType
- - тип операции для получения пользователей которые делегировали права пользователю
(по ним определяется максимальный уровень иерархии верх который нужно отображать и
подчиненные должности)search
- текстовый поискdepartmentID
- идентификатор департамента, чьи дочерние должности (всю иерархию) необходимо отображать для всей иерархииfilterDepartmentID
- идентификатор департамента чьи непосредственные должности нужно отображатьfilterUserID
- идентификатор пользователя чьи должности необходимо отображатьvaluesToCheck
- проверяемые значения идентификаторов должностей передается как valuesToCheck=identifier1&valuesToCheck=identifier2public Response addOftenChosenUsers(java.util.List<java.lang.String> users)
public Response getOftenChosenUsers(int startRecord, int recordsCount, java.lang.String locale, boolean showAll, java.lang.String search, java.lang.Integer operationType, java.lang.Integer ownerOperationType, java.lang.String filterPositionID, java.lang.String filterDepartmentID, java.lang.Integer positionType, java.util.List<java.lang.String> customFields, java.lang.String userNameDisplayType)
public Response getPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> customFields)
public Response getAllPositions(int startRecord, int recordsCount, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID)
public Response getOftenPositions(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.Integer operationType, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.util.List<java.lang.String> customFields)
public Response getDepartments(int pageNumber, int countInPart, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterChildDepartmentID, java.lang.String filterPositionID, java.lang.String search, boolean showChildDepartments, java.lang.String filterHrUser, java.lang.String filterUserID, java.lang.String locale)
pageNumber
- номер страницы результата (0 по умолчанию)countInPart
- количество департаментов в ответе (30 по умолчанию)showChildDepartments
- показывать ли дочерние подразделенияfilterHrUser
- Фильтр ограничивает департаменты теми, к которым имеет доступ hr-пользовательfilterUserID
- идентификатор пользователя чьи должности необходимо показатьpublic Response checkDepartments(int pageNumber, int countInPart, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterChildDepartmentID, java.lang.String filterPositionID, java.lang.String search, boolean showChildDepartments, java.lang.String filterHrUser, java.util.List<java.lang.String> valuesToCheck, java.lang.String filterUserID, java.lang.String locale)
public java.lang.String getUserID()
public class AddressBookService
extends java.lang.Object
Constructor and Description |
---|
AddressBookService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAddressBookItem(java.lang.String itemID,
java.lang.String locale)
Получение данных об объекте из адресной книги по id
Тип: GET
URL: rest/api/addressbook/get_addressbook_item
|
Response |
getAddressBookItems(int countInPart,
int pageNumber,
java.lang.String search,
java.lang.String startLetter,
int itemType,
java.lang.String userID,
java.lang.String locale) |
java.lang.String |
getUserID() |
public java.lang.String getAddressBookItem(java.lang.String itemID, java.lang.String locale)
itemID
- - id объектаlocale
- - локальpublic Response getAddressBookItems(int countInPart, int pageNumber, java.lang.String search, java.lang.String startLetter, int itemType, java.lang.String userID, java.lang.String locale)
countInPart
- сколько элементов в одной странице, по умолчанию 15pageNumber
- номер страницы, по умолчанию 0search
- текст поскаstartLetter
- точно не знаюitemType
- 0 искать по пользователям, 1 искать по организациям по умолчанию 0.userID
- пользователь, чья адресная книга просматриваетсяlocale
- локальpublic java.lang.String getUserID()
public class SettingsService
extends java.lang.Object
Constructor and Description |
---|
SettingsService() |
Modifier and Type | Method and Description |
---|---|
Response |
clearMicrosoftSessionStorage() |
Response |
deleteFromMicrosoftSessionStorage(java.lang.String sessionState) |
Response |
getMicrosoftAuthConfig() |
Response |
getMicrosoftSessionStorage() |
java.lang.String |
getProcesses(java.lang.String locale)
Метод возвращает список основных процессов, которые используется в системе
URL: rest/api/settings/get_processes Тип GET |
Response |
getSecuritySettings() |
java.lang.String |
getSettings(java.lang.String locale)
Метод возвращает настройки приложения, необходимые для работы приложения
URL rest/api/settings/get
Method GET day_start_time - время начала рабочего дня day_finish_time - время завершения рабочего дня work_completion_forms - список доступных форм завершения работы, для каждой формы завершения указываются id - код формы завершения name - название формы завершения docflow_demand_sign_before_assign - обязательно ли подписание документов перед отправкой; display_author_input - отображать ли поле "автор" при создании работы allow_create_additional_resolutions - разрешить накладывать дополнительные резолюции do_not_remove_resolution_work - не удалять работу, на которую была наложена резолюция completion_date_for_resolution - подставлять дату завершения документа в пункты резолюции date_resolution_after_finish_document - разрешено ли ставить работы по резолюции, завершающиеся после документа resolution_create_levels - количество уровней оргструктуры с правом на создание резолюции docflow_resolution_template - шаблон пункта резолюции allow_add_work_responsibles - разрешать добавлять к работе соисполнителей (не из числа подчниненных) set_work_from_responsible - ставить работы исполнителям от имени ответственного allow_resend_work - позволять передавать работу signed_off - лейбл "Отписано" current_priorities - текущие приоритеты в системе all_priorities - все доступные приоритеты в системе dialogs - все доступные диалоги в системе (name - имя, uuid - uuid, type - тип) work_items - доступные пункты меню (модуль "Потоки работ") document_items - доступные пункты меню (модуль "Документы") file_items - доступные пункты меню (модуль "Файлы") day_length - длительность рабочего дня (из календаря Системы) default_work_length - время на выполнение работы по умолчанию default_document_project_work_length - время на выполнение проекта документа (в т.ч. по шаблону) по умолчанию default_agreement_length - время на выполнение согласования по умолчанию default_approvement_length - время на выполнение утверждения по умолчанию default_acquaintance_length - время на выполнение ознакомления по умолчанию systemName - наименование системы resolution_work_types - доступные пункты типов работ по резолюции, для каждого пункта указываются needCert - требовать ключ и сертификат enableEDS - настроено ли ЭЦП dict_id - UUID записи справочника; item_number - порядковый номер пункта в выпадающем списке; item_process - действие, которое осуществляет пункт; item_name - название пункта типа работы. |
java.lang.String |
getUserID()
Метод возвращает UUID пользователя, вызвавшего метод
|
Response |
getUsersBuffer() |
Response |
getWorkDays(java.lang.String date_start,
java.lang.String date_finish,
java.lang.String type)
Метод возвращает периоды рабочего времени с типами для каждого дня в запрашиваемом интервале
URL: rest/api/settings/calendar Тип GET |
Response |
saveMicrosoftAuthConfig(MicrosoftEntraDTO microsoftEntraDTO) |
java.lang.String |
setSettings(<any> settings)
Изменение настроек системы.
|
public java.lang.String getSettings(java.lang.String locale)
Метод возвращает настройки приложения, необходимые для работы приложения
URL rest/api/settings/getlocale
- локаль пользователяarta.synergy.web.common.client.data.actions.dialog.WorkDialogType#WORK
,
arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#DOCUMENT_PROJECT
,
arta.synergy.web.common.client.data.actions.dialog.WorkDialogType#TEMPLATE_PROJECT
public Response getSecuritySettings()
public java.lang.String setSettings(<any> settings)
Изменение настроек системы. Можно изменить настройки для администратора и для методолога. Администратору и методологу доступны свои настройки, соответствующий разделением в интерфейсе.
Если пользователь является и администратором и методологом, то ему будут доступны все настройки.
Все настройки надо передавать в форме. Название, параметра должна совпадать с id настройки. Если не будет найден ни одна настройка по такому id. Сервер вернет следующую ошибку:
{"errorCode": 13, "errorMessage": ""Настройка с id {id} не найдена"} Объект ответа это json с полямиpublic java.lang.String getProcesses(java.lang.String locale)
locale
- локаль пользователя
В случае успешного выполнения возвращает json c полями: name - название процесса на языке локали, переданной в параметре locale number - порядковый номер следования в списке type - тип операции, один из следующих вариантов: ASSIGNMENT_ITEM - работа AGREEMENT_ITEM - согласование APPROVAL_ITEM - утверждение ACQUAINTANCE_ITEM - ознакомление RESOLUTION_ACTION - резолюция SEND_DOCUMENT - отправка документа BLOCKING_PROCESS - блокирующий процесс REGISTRATION_ITEM - регистрация ROUTE_ITEM - маршрут SEND_DOCUMENT_BY_FORM - отправка документа по форме POSITION_APPOINMENT_ITEM - назначение на должность POSITION_TRANSFER_ITEM - перевод POSITION_DISCHARGE_ITEM - увольнение COPY_TO_PR_FOLDER_ITEM - копирование в личную папку CALENDAR_APPOINTEMENT_ITEM - назначение календаря REGISTER_EVENT_ITEM - событие реестра QUERY_RESULT - результат запроса COMMON_PROCESS_BY_FORM - работа по форме POINTERS_INPUT - ввод значения показателя TIMER - таймер ROUTE_TEMPLATE - запуск маршрута по шаблону CONDITION - условный переход COPY_TO_CARD - копирование в карточку REASSIGN_WORK - переназначение работ
public Response getWorkDays(java.lang.String date_start, java.lang.String date_finish, java.lang.String type)
date_start
- дата начала интервала в формате yyyy-MM-dd (обязат.)date_finish
- дата завершения интервала в формате yyyy-MM-dd (обязат.)type
- тип дня, может быть стандартный "standard", нестандартный "custom", выходной "holiday" (не обязат.)Пример запроса без указания параметра type: `rest/api/settings/calendar?date_start=2016-05-01&date_finish=2016-05-04` Пример ответа на запрос без указания параметра type: { "2015-05-01": [ { "type": "holiday" } ], "2015-05-02": [ { "start": "09:00", "finish": "13:00", "type": "custom" } ], "2015-05-03": [ { "type" : "holiday" } ], "2015-05-04": [ { "start": "09:00", "finish": "13:00", "type" : "standard" }, { "start": "14:00", "finish": "18:00", "type" : "standard" } ] } Где ключами являются даты интервала в формате yyyy-MM-dd, а значениями - список объектов с полями start, finish и type в которых указано время начала и завершения промежутка рабочего времени в формате HH:mm и тип дня этого промежутка Пример запроса с указанием параметра type: `rest/api/settings/calendar?date_start=2016-05-01&date_finish=2016-05-04&type=standard` Пример ответа на запрос с указанием параметра type: { "2015-05-03": [ { "start": "09:00", "finish": "13:00", "type" : "standard" }, { "start": "14:00", "finish": "18:00", "type" : "standard" } ], "2015-05-04": [ { "start": "09:00", "finish": "13:00", "type" : "standard" }, { "start": "14:00", "finish": "18:00", "type" : "standard" } ] }
public Response getMicrosoftAuthConfig()
public Response saveMicrosoftAuthConfig(MicrosoftEntraDTO microsoftEntraDTO)
public Response getMicrosoftSessionStorage()
public Response clearMicrosoftSessionStorage()
public Response deleteFromMicrosoftSessionStorage(java.lang.String sessionState)
public Response getUsersBuffer()
public java.lang.String getUserID()
public class AuthService
extends java.lang.Object
Constructor and Description |
---|
AuthService() |
Modifier and Type | Method and Description |
---|---|
Response |
checkUser()
API для авторизации пользователя
|
Response |
checkUserIsAdmin(java.lang.String role)
API для авторизации суперадмина и суперметодолога
URL rest/api/auth/{role} Method GET |
java.lang.String |
getUserID() |
public Response checkUserIsAdmin(java.lang.String role)
role
- роль пользователя, с которой он хочет авторизоваться, один из трех вариантов
public Response checkUser()
checkUserIsAdmin(java.lang.String)
public java.lang.String getUserID()
public class ProcessesService
extends java.lang.Object
Constructor and Description |
---|
ProcessesService() |
Modifier and Type | Method and Description |
---|---|
Response |
competeProcess(java.lang.String signal,
java.lang.String executionID,
java.lang.String locale)
Метод отправляет сигнал блокирующему процессу для его завершения в системе и восстановления работы маршрута
URL rest/api/processes/signal
Method GET Так же метод принимает дополнительные опциональные параметры, передаваемые процессу. |
java.lang.String |
getHost() |
java.lang.String |
getUserID() |
Response |
retryBP(java.lang.String documentID)
Метод переотправки в очередь незавершенных блок процессов в указанном документе
* URL rest/api/processes/retry_bp
*
Method POST Пример: rest/api/processes/retry_bp? |
public Response competeProcess(java.lang.String signal, java.lang.String executionID, java.lang.String locale)
Метод отправляет сигнал блокирующему процессу для его завершения в системе и восстановления работы маршрута
URL rest/api/processes/signal
Так же метод принимает дополнительные опциональные параметры, передаваемые процессу.
Для того чтобы передать параметр и значение необходимо передать запросу параметры :
paramN=название_параметра и valueN=значение_параметра, где N - порядковый номер параметра (нумерация с 1)
Поддерживаемые параметры:
Примеры:
Успешное завершение процесса с комментарием
rest/api/processes/signal?signal=got_agree¶m1=resolution&value1=Действие успешно выполнено&executionID=id_процесса
Успешное завершение процесса без комментария
rest/api/processes/signal?signal=got_agree&executionID=id_процесса
Не успешное завершение процесса с комментарием
rest/api/processes/signal?signal=got_refuse¶m1=resolution&value1=Действие не выполнено&executionID=id_процесса
Не успешное завершение процесса без комментария
rest/api/processes/signal?signal=got_refuse&executionID=id_процесса
signal
- результат завершения блокирующего процесса: got_agree - успешное завершения, got_refuse - неуспешное завершениеexecutionID
- идентификатор процессаlocale
- локальpublic Response retryBP(java.lang.String documentID)
rest/api/processes/retry_bp?documentID=document_identifier
documentID
- query param ид документаpublic java.lang.String getHost()
public java.lang.String getUserID()
public class DiagnosticsService
extends java.lang.Object
Constructor and Description |
---|
DiagnosticsService() |
Modifier and Type | Method and Description |
---|---|
Response |
doHeapDump(java.lang.String targetDirectory,
boolean isZipped)
Метод не доступен через контроллер, т.к. не востребован — оставлен на случай, если понадобится в будущем
|
Response |
doThreadDump() |
Response |
downloadHeapDump(java.lang.String targetDirectory,
boolean isZipped)
Метод не доступен через контроллер, т.к. не востребован — оставлен на случай, если понадобится в будущем
|
Response |
downloadLogs(java.lang.String directory,
java.lang.String fileName,
java.lang.String zipName) |
Response |
downloadThreadDump() |
Response |
getConstructorResource(java.lang.Integer id) |
Response |
getConstructorScript(java.lang.String scriptType,
java.lang.Integer id,
java.lang.String code) |
Response |
getCorruptedFiles() |
Response |
getCustomInterpreterScript(java.lang.Integer id,
java.lang.String code) |
Response |
getDBProcessList() |
Response |
getDocumentsTop(java.lang.String startDate,
java.lang.String endDate) |
Response |
getElasticStatus() |
Response |
getInnoDBStatus() |
Response |
getInterpreterMap(java.lang.String startDate,
java.lang.String endDate,
java.lang.String scriptName) |
Response |
getInterpreterScript(java.lang.Integer id,
java.lang.String code,
java.lang.String name) |
java.lang.String |
getJBossPID() |
Response |
getProcessesErrors() |
Response |
getRecentlyModifiedAppObjects(java.lang.String startDate,
java.lang.String endDate) |
Response |
getRoutesFrozen() |
Response |
getRoutesTop(java.lang.String startDate,
java.lang.String endDate) |
Response |
getRouteTransferCycles(java.lang.String startDate,
java.lang.String endDate) |
Response |
getTransferCycles(java.lang.String startDate,
java.lang.String endDate,
java.lang.Integer limit) |
void |
init(DiagnosticsManager manager) |
Response |
interruptProcess(java.lang.String documentID,
java.lang.String routeID) |
Response |
listAllFormsWithScripts() |
Response |
listDBTablesWeights(java.lang.String schema) |
Response |
listElasticIndices() |
Response |
listElasticShards() |
Response |
listFormScripts(java.lang.String uuid,
java.lang.String code) |
Response |
listLogFiles(java.lang.String directory) |
Response |
listNewConstructorResources(java.lang.String startDate,
java.lang.String endDate) |
Response |
listNewConstructorScripts(java.lang.String startDate,
java.lang.String endDate) |
Response |
restoreElastic() |
public void init(DiagnosticsManager manager)
public Response getRecentlyModifiedAppObjects(java.lang.String startDate, java.lang.String endDate) throws java.sql.SQLException
java.sql.SQLException
public Response getInterpreterMap(java.lang.String startDate, java.lang.String endDate, java.lang.String scriptName) throws java.sql.SQLException
java.sql.SQLException
public Response getInterpreterScript(java.lang.Integer id, java.lang.String code, java.lang.String name) throws java.sql.SQLException
java.sql.SQLException
public Response getCustomInterpreterScript(java.lang.Integer id, java.lang.String code) throws java.sql.SQLException
java.sql.SQLException
public Response getDocumentsTop(java.lang.String startDate, java.lang.String endDate) throws java.sql.SQLException
java.sql.SQLException
public Response getRoutesTop(java.lang.String startDate, java.lang.String endDate) throws java.sql.SQLException
java.sql.SQLException
public Response getTransferCycles(java.lang.String startDate, java.lang.String endDate, java.lang.Integer limit) throws java.sql.SQLException
java.sql.SQLException
public Response getRouteTransferCycles(java.lang.String startDate, java.lang.String endDate) throws java.sql.SQLException
java.sql.SQLException
public Response interruptProcess(java.lang.String documentID, java.lang.String routeID) throws java.sql.SQLException
java.sql.SQLException
public Response listAllFormsWithScripts() throws java.sql.SQLException
java.sql.SQLException
public Response listFormScripts(java.lang.String uuid, java.lang.String code) throws java.sql.SQLException, java.io.IOException
java.sql.SQLException
java.io.IOException
public Response getCorruptedFiles() throws java.sql.SQLException
java.sql.SQLException
public Response listNewConstructorResources(java.lang.String startDate, java.lang.String endDate) throws java.lang.Exception
java.lang.Exception
public Response getConstructorResource(java.lang.Integer id) throws java.lang.Exception
java.lang.Exception
public Response listNewConstructorScripts(java.lang.String startDate, java.lang.String endDate) throws java.sql.SQLException
java.sql.SQLException
public Response getConstructorScript(java.lang.String scriptType, java.lang.Integer id, java.lang.String code) throws java.sql.SQLException
java.sql.SQLException
public Response getRoutesFrozen() throws java.sql.SQLException
java.sql.SQLException
public Response getProcessesErrors() throws java.sql.SQLException
java.sql.SQLException
public Response listLogFiles(java.lang.String directory)
public Response downloadLogs(java.lang.String directory, java.lang.String fileName, java.lang.String zipName) throws java.lang.Exception
java.lang.Exception
public Response getDBProcessList() throws java.sql.SQLException
java.sql.SQLException
public Response getInnoDBStatus() throws java.sql.SQLException
java.sql.SQLException
public Response listDBTablesWeights(java.lang.String schema) throws java.sql.SQLException
java.sql.SQLException
public Response getElasticStatus() throws java.io.IOException, ElasticConfigException
java.io.IOException
ElasticConfigException
public Response listElasticShards() throws java.io.IOException, ElasticConfigException
java.io.IOException
ElasticConfigException
public Response listElasticIndices() throws java.io.IOException, ElasticConfigException
java.io.IOException
ElasticConfigException
public Response restoreElastic() throws java.io.IOException, ElasticConfigException
java.io.IOException
ElasticConfigException
public Response doThreadDump() throws java.io.IOException, java.lang.InterruptedException
java.io.IOException
java.lang.InterruptedException
public Response downloadThreadDump() throws java.lang.Exception
java.lang.Exception
public Response doHeapDump(java.lang.String targetDirectory, boolean isZipped) throws java.io.IOException, java.lang.InterruptedException
java.io.IOException
java.lang.InterruptedException
public Response downloadHeapDump(java.lang.String targetDirectory, boolean isZipped) throws java.lang.Exception
java.lang.Exception
public java.lang.String getJBossPID()
public class MobileUtilsService
extends java.lang.Object
Constructor and Description |
---|
MobileUtilsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addDeviceToken(java.lang.String token,
java.lang.String type,
java.lang.String locale)
Метод добавляет в систему token устройства для авторизовавшегося пользователя
URL rest/api/mobile/utils/add_token Method GET Параметры метода: token идентификатор устройства type тип устройства locale локаль пользователя Объект ответа: json c полями: errorCode результат выполнения метода (0 - успешно, иначе - ошибка) errorMessage сообщение об ошибке |
java.lang.String |
getLocale() |
java.lang.String |
getUserID() |
java.lang.String |
removeDeviceToken(java.lang.String token,
java.lang.String locale)
Метод добавляет в систему token устройства для авторизовавшегося пользователя
URL rest/api/mobile/utils/remove_token Method GET Параметры метода: token идентифкатор устройства locale локаль пользователя Ответ: json c полями: errorCode результат выполнения метода (0 - успешно, иначе - ошибка) errorMessage сообщение об ошибке |
public java.lang.String addDeviceToken(java.lang.String token, java.lang.String type, java.lang.String locale)
Метод добавляет в систему token устройства для авторизовавшегося пользователя
errorCode
результат выполнения метода (0 - успешно, иначе - ошибка)errorMessage
сообщение об ошибкеpublic java.lang.String removeDeviceToken(java.lang.String token, java.lang.String locale)
Метод добавляет в систему token устройства для авторизовавшегося пользователя
errorCode
результат выполнения метода (0 - успешно, иначе - ошибка)errorMessage
сообщение об ошибкеpublic java.lang.String getUserID()
public java.lang.String getLocale()
public class UsersService
extends java.lang.Object
Constructor and Description |
---|
UsersService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getUserID() |
Response |
listLoggedInUsers(java.lang.String showIdsStr) |
Response |
logout(java.util.List<java.lang.String> users) |
public class MobileAuthorizationService
extends java.lang.Object
Constructor and Description |
---|
MobileAuthorizationService() |
Modifier and Type | Method and Description |
---|---|
Response |
setAccessForUsers(MobileAuthorizeDTO mobileAuthorizeDTO)
Сохранение доступа в мобильное приложение для пользователей.
|
public Response setAccessForUsers(MobileAuthorizeDTO mobileAuthorizeDTO)
public class FormIndexService
extends java.lang.Object
Constructor and Description |
---|
FormIndexService() |
Modifier and Type | Method and Description |
---|---|
Response |
getMaxVersion(java.lang.String locale,
boolean continueLast,
long sleepTime)
Начинает индекс форм
URL: /rest/api/admin/forms/index
Тип: POST
Данный метод доступен только пользователям с правами суперадминистратора.
|
Response |
getState(java.lang.String locale,
boolean getMessages)
Статус текущего индексирования
URL: /rest/api/admin/forms/index
Тип: GET
Данный метод доступен только пользователям с правами суперадминистратора.
|
java.lang.String |
getUserID() |
public Response getMaxVersion(java.lang.String locale, boolean continueLast, long sleepTime)
Начинает индекс форм
URL: /rest/api/admin/forms/index
Тип: POST
Данный метод доступен только пользователям с правами суперадминистратора.
continue(true, false) - продолжить предыдущий индекс, по умолчанию false
interval(число) - время между индексом на отдельные данные форм
{
"errorCode": 13,
"errorMessage":"Индексирование уже начато"
}
public Response getState(java.lang.String locale, boolean getMessages)
Статус текущего индексирования
URL: /rest/api/admin/forms/index
Тип: GET
Данный метод доступен только пользователям с правами суперадминистратора.
messages(true, false) - возвращать ли сообщения индексирования
{
"running": true,
"messages": ["first messages", "second message"]
}
public java.lang.String getUserID()
public class DocumentIndexService
extends java.lang.Object
Constructor and Description |
---|
DocumentIndexService() |
Modifier and Type | Method and Description |
---|---|
Response |
getMaxVersion(java.lang.String locale,
boolean continueLast,
long sleepTime)
Начинает индекс документов
URL: /rest/api/admin/docs/index
Тип: POST
Данный метод доступен только пользователям с правами суперадминистратора.
|
Response |
getState(java.lang.String locale,
boolean getMessages)
Статус текущего индексирования
URL: /rest/api/admin/docs/index
Тип: GET
Данный метод доступен только пользователям с правами суперадминистратора.
|
java.lang.String |
getUserID() |
Response |
sendDocToIndex(java.lang.String documentID)
TODO Индексация одного документа для тестирования
|
public Response getMaxVersion(java.lang.String locale, boolean continueLast, long sleepTime)
Начинает индекс документов
URL: /rest/api/admin/docs/index
Тип: POST
Данный метод доступен только пользователям с правами суперадминистратора.
continue(true, false) - продолжить предыдущий индекс, по умолчанию false
interval(число) - время между индексом на отдельные данные форм
{
"errorCode": 13,
"errorMessage":"Индексирование уже начато"
}
public Response getState(java.lang.String locale, boolean getMessages)
Статус текущего индексирования
URL: /rest/api/admin/docs/index
Тип: GET
Данный метод доступен только пользователям с правами суперадминистратора.
messages(true, false) - возвращать ли сообщения индексирования
{
"running": true,
"messages": ["first messages", "second message"]
}
public java.lang.String getUserID()
public Response sendDocToIndex(java.lang.String documentID)
documentID
- public class DBService
extends java.lang.Object
Constructor and Description |
---|
DBService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDbVersion()
Текущая версия базы данных
URL: rest/api/admin/db/current_version
Type: GET |
java.lang.String |
getMaxVersion()
Максимальная версия базы данных, на которую можно обновиться
URL: rest/api/admin/db/max_version
Type: GET |
java.lang.String |
getMessages()
Сообщении об выполнения обновления базы данных.
|
java.lang.String |
getUserID() |
java.lang.String |
onDbUpdated()
Обнуляет статическую карту с правилами, для того чтобы при последующем использовании она была перезагружена.
|
java.lang.String |
startUpdate()
Запуск обновления базы данных.
|
java.lang.String |
updatingIsCompleted()
Проверка статуса выполнения обновление базы.
|
public java.lang.String getMaxVersion()
public java.lang.String getDbVersion()
public java.lang.String startUpdate()
Процесс обновления базы данных:
URL: rest/api/admin/db/start_update
Type: GET
public java.lang.String getMessages()
public java.lang.String updatingIsCompleted()
public java.lang.String onDbUpdated()
public java.lang.String getUserID()
public class DiaryService
extends java.lang.Object
Constructor and Description |
---|
DiaryService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createTask(java.lang.String task,
java.lang.String taskID,
java.lang.String start,
java.lang.String finish,
boolean wholeDay,
java.lang.String userID,
java.lang.String locale)
Метод для создания/изменения задачи
URL rest/api/diary/tasks/{userID}/save
Method POST |
java.lang.String |
deleteTask(java.lang.String taskID,
java.lang.String locale)
Метод для удаление задачи
URL rest/api/diary/tasks/delete
Method GET |
java.lang.String |
getModifiedTasks(java.lang.String userID,
java.lang.String locale,
java.lang.String lastModified)
Метод возвращает заметки измененные за последнее время URL rest/api/diary/tasks/{userID} Method GET Пример: http://хост:порт/Synergy/rest/api/diary/tasks/uuid_пользователя? |
Response |
getTask(java.lang.String taskID,
java.lang.String locale)
Получение заметки по идентификатору
URL /rest/api/diary/tasks/get
Method GET Метод принимает следующие входные параметры: - `taskID` - `uuid` заметки (обяз.); - `locale` - локаль. |
java.lang.String |
getUserID() |
Response |
getUserTasks(java.lang.String userID,
java.lang.String start,
java.lang.String finish,
java.lang.String locale)
Получения заметок пользователя из календаря за промежуток времени
URL rest/api/diary/tasks/{userID}/all
Method GET |
Response |
setTaskState(java.lang.String taskID,
java.lang.String locale)
Метод для завершения заментки
URL rest/api/diary/tasks/complete
Method GET |
public java.lang.String getModifiedTasks(java.lang.String userID, java.lang.String locale, java.lang.String lastModified)
Метод возвращает заметки измененные за последнее время
URL rest/api/diary/tasks/{userID}
Method GET
userID
- uuid пользователя, чьи задачи необходимо посмотретьlocale
- локальlastModified
- стамп времени#taskToJson(arta.synergy.web.common.client.data.tasks.Task)
public java.lang.String createTask(java.lang.String task, java.lang.String taskID, java.lang.String start, java.lang.String finish, boolean wholeDay, java.lang.String userID, java.lang.String locale)
Метод для создания/изменения задачи
URL rest/api/diary/tasks/{userID}/save
Method POST
task
- текст задачиtaskID
- идентификатор задачи (в случае добавления новой задачи должен отсутствовать)start
- дата начала в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)finish
- дата завершения в формате yyyy-MM-dd либо yyyy-MM-dd HH:mm:00 (первый для задач в течение дня, второй для задач с конкретным временем)wholeDay
- в течение целого дня или нетuserID
- идентификатор пользователя для которого создается задачаlocale
- локальpublic java.lang.String deleteTask(java.lang.String taskID, java.lang.String locale)
Метод для удаление задачи
URL rest/api/diary/tasks/delete
Method GET
taskID
- идентификатор задачиlocale
- локальpublic Response setTaskState(java.lang.String taskID, java.lang.String locale)
Метод для завершения заментки
URL rest/api/diary/tasks/complete
Method GET
taskID
- идентификатор задачи (в случае добавления новой задачи должен отсутствовать)locale
- локаль
Пример запроса:
`/rest/api/diary/tasks/complete?taskID=e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee`
Пример возвращаемого объекта:
{
"errorCode": 0,
"errorMessage": "Заметка успешно завершена"
}public Response getTask(java.lang.String taskID, java.lang.String locale)
Получение заметки по идентификатору
URL /rest/api/diary/tasks/get
Method GET
Метод принимает следующие входные параметры:
public Response getUserTasks(java.lang.String userID, java.lang.String start, java.lang.String finish, java.lang.String locale)
Получения заметок пользователя из календаря за промежуток времени
URL rest/api/diary/tasks/{userID}/all
Method GET
start
- дата начала в формате yyyy-MM-ddfinish
- дата завершения в формате yyyy-MM-dduserID
- идентификатор пользователя чьи заметки необходимо получитьlocale
- локаль
Пример запроса:
`rest/api/diary/tasks/8f60bf3b-0fff-11e9-bfb4-001ef892a4ee/all?start=2016-12-05&finish=2016-12-25`
Пример возвращаемого массива:
[
{
"taskID" : "e6fc40b0-9fe4-11e6-9ce4-001ef892a4ee",
"task" : "заметка №1",
"start" : "2016-12-05 10:00:00",
"finish" : "2016-12-05 16:00:00"
},
{
"taskID" : "5dfc40b0-9fe4-11e6-9ce4-001ef892a4ee",
"task" : "заметка №2",
"start" : "2016-12-10 09:45:00",
"finish" : "2016-12-10 12:00:00"
},
{
"taskID" : "21sdd1sb0-9fe4-11e6-9ce4-001ef892a4ee",
"task" : "заметка №3",
"start" : "2016-12-20 09:00:00",
"finish" : "2016-12-20 18:00:00"
},
{
"taskID" : "11lc40b0-5fkh-11e6-9ce4-001ef892a4ee",
"task" : "заметка №4",
"start" : "2016-12-25 09:00:00",
"finish" : "2016-12-25 18:00:00"
}
]public java.lang.String getUserID()
public class ApplicationImportServlet
extends HttpServlet
Constructor and Description |
---|
ApplicationImportServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doPost(HttpServletRequest req,
HttpServletResponse res) |
public class ApplicationExportServlet
extends HttpServlet
Constructor and Description |
---|
ApplicationExportServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest req,
HttpServletResponse res) |
public class PersonalRecordService
extends java.lang.Object
Constructor and Description |
---|
PersonalRecordService() |
Modifier and Type | Method and Description |
---|---|
Response |
createFolders()
Метод используется для создания папок личного дела в хранилище
Тип: POST
URL: rest/api/storage/recreatefolders
|
java.lang.String |
getForms(java.lang.String userID,
java.lang.String locale)
Метод возвращает информацию о личных карточках пользователя (названия и идентификаторы форм)
URL rest/api/personalrecord/forms/{userID}
Method GET Метод возвращает список из элементов, каждый из которых описывает одну личную карточку. |
java.lang.String |
getUserID() |
Response |
removeOldFolders()
Метод используется для удаления из хранилища всех папок личного дела, которых нет в таблицах MySql, но есть в хранилище.
|
public java.lang.String getForms(java.lang.String userID, java.lang.String locale)
Метод возвращает информацию о личных карточках пользователя (названия и идентификаторы форм)
URL rest/api/personalrecord/forms/{userID}userID
- UUID пользователя, чьи карточки необходимо получить (PathParam)locale
- локаль пользователя, делающего запрос (QueryParam)public Response createFolders()
public Response removeOldFolders()
public java.lang.String getUserID()
public class GroupsService
extends java.lang.Object
Constructor and Description |
---|
GroupsService() |
Modifier and Type | Method and Description |
---|---|
Response |
get(int groupID,
java.lang.String search,
java.lang.String locale) |
Response |
getGroupContent(java.lang.String search,
java.lang.Integer parentGroupID,
java.lang.Integer startRecord,
java.lang.Integer recordsCount,
java.lang.Integer right,
boolean loadAutoGroups,
java.lang.String locale) |
Response |
getGroups(java.lang.String search,
java.lang.Integer parentGroupID,
java.lang.String parentGroupCode,
java.lang.Integer startRecord,
java.lang.Integer recordsCount,
boolean loadAllHierarchy,
java.lang.Integer right,
boolean loadAutoGroups,
java.lang.String locale)
поиск групп
|
java.lang.String |
getUserID() |
public Response getGroups(java.lang.String search, java.lang.Integer parentGroupID, java.lang.String parentGroupCode, java.lang.Integer startRecord, java.lang.Integer recordsCount, boolean loadAllHierarchy, java.lang.Integer right, boolean loadAutoGroups, java.lang.String locale)
public Response getGroupContent(java.lang.String search, java.lang.Integer parentGroupID, java.lang.Integer startRecord, java.lang.Integer recordsCount, java.lang.Integer right, boolean loadAutoGroups, java.lang.String locale)
public Response get(int groupID, java.lang.String search, java.lang.String locale)
public java.lang.String getUserID()
public class DepartmetnsService
extends java.lang.Object
Constructor and Description |
---|
DepartmetnsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
deleteDepartment(java.lang.String departmentID,
java.lang.String locale)
Метод удаляет подразделение
URL rest/api/departments/delete
Method GET |
java.lang.String |
getDepartment(java.lang.String departmentID,
java.lang.String locale)
Метод возвращает информацию о подразделении подразделение
URL rest/api/departments/get
Method GET |
java.lang.String |
getDepartmentCards(java.lang.String departmentID,
java.lang.String locale)
Возвращает список дополнительных карточек для данного подразделения
URL rest/api/departments/get_cards
Method GET Для заполнения полей карточки надо использовать метод APIFormsService#save |
java.lang.String |
getDepartmentsAsList(java.lang.String locale,
java.lang.Integer partNumber,
java.lang.Integer countInPart)
Метод возвращает список подразделений (без учета структуры)
URL rest/api/departments/list
Method GET * @return Список департаментов, описание полей департамента смотрите в методе FileCabinetWrapper#getDepartmentasJson |
java.lang.String |
getDepartmentsByFieldValue(java.lang.String formUUID,
java.lang.String formCode,
java.lang.String fieldName,
java.lang.String value,
java.lang.String locale)
ВНИМАНИЕ!
|
java.lang.String |
getDepartmentsContent(java.lang.String departmentID,
boolean onlyPosition,
boolean onlyDepartments,
java.lang.String locale)
Метод используется для получения информации о департаменте (подразделения и должности)
Тип: GET
URL: rest/api/departments/content
|
java.lang.String |
getUserID() |
java.lang.String |
saveDepartment(java.lang.String nameRu,
java.lang.String nameKz,
java.lang.String nameEn,
java.lang.String positionNameRu,
java.lang.String positionNameKz,
java.lang.String positionNameEn,
java.lang.String pointersCode,
java.lang.String departmentID,
java.lang.String parentDepartmentID,
int number,
java.lang.String locale)
Метод создает/изменяет подразделение орг структуры
URL rest/api/departments/save
Method POST |
Response |
searchDepartments(java.util.List<java.lang.String> codes,
java.util.List<java.lang.String> names,
int recordsCount,
int startRecord,
java.lang.String codeSearchTypeP,
java.lang.String nameSearchTypeP,
java.lang.String deleted,
java.lang.String locale)
Метод поиска подразделений
URL: /rest/api/departments/search
Тип: GET
Метод принимает следующие параметры:
name - название подразделения (необяз.), может быть передано несколько значений
pointer_code - код показателя (необяз.), может быть передано несколько значений
recordsCount - количество результатов, которые необходимо вернуть (по умолчанию 30). |
public java.lang.String saveDepartment(java.lang.String nameRu, java.lang.String nameKz, java.lang.String nameEn, java.lang.String positionNameRu, java.lang.String positionNameKz, java.lang.String positionNameEn, java.lang.String pointersCode, java.lang.String departmentID, java.lang.String parentDepartmentID, int number, java.lang.String locale)
Метод создает/изменяет подразделение орг структуры
URL rest/api/departments/savenameRu
- Название подразделения на русском языке, FormParamnameKz
- Название подразделения на казахском языке, FormParamnameEn
- Название подразделения на английском языке, FormParampositionNameRu
- Название должности руководителя на русском языке, FormParampositionNameKz
- Название должности руководителя на казахском языке, FormParampositionNameEn
- Название должности руководителя на английском языке, FormParampointersCode
- код показателя, FormParamnumber
- порядковый номер подразделенияdepartmentID
- UUID подразделения (для создания нового подразделения необходимо передать null), FormParamparentDepartmentID
- UUID родительского подразделения, FormParamlocale
- локаль, QueryParampublic java.lang.String deleteDepartment(java.lang.String departmentID, java.lang.String locale)
Метод удаляет подразделение
URL rest/api/departments/deletedepartmentID
- UUID подразделения, которое надо удалить (QueryParam)locale
- локаль (QueryParam)public java.lang.String getDepartment(java.lang.String departmentID, java.lang.String locale)
Метод возвращает информацию о подразделении подразделение
URL rest/api/departments/getdepartmentID
- UUID подразделения, QueryParamlocale
- локаль, QueryParamFileCabinetWrapper#getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)
public java.lang.String getDepartmentsAsList(java.lang.String locale, java.lang.Integer partNumber, java.lang.Integer countInPart)
Метод возвращает список подразделений (без учета структуры)
URL rest/api/departments/listFileCabinetWrapper#getDepartmentasJson(arta.synergy.web.common.client.data.filecabinet.Department, String)
public java.lang.String getDepartmentsContent(java.lang.String departmentID, boolean onlyPosition, boolean onlyDepartments, java.lang.String locale)
departmentID
- идентификатор департаментаonlyPosition
- true - отображение должностей только одного департамента (по умолчанию false)onlyDepartments
- true - отображение подотделов только одного департамента (по умолчанию false)locale
- локаль[ { "departments": [ { "departmentID": "7b097e72-e303-487f-83a1-cb76397abd57", "departmentName": "Департамент технологий", "hasChildDepartments" : false, "pointerCode" : "code", "departmentHead": { "headID": "f9b0b304-c856-4bcf-8615-e13cded16a14", "headName": "Иванов И.И." } }, { "departmentID": "8ii056e72-e563-667f-14j7-cb31867qwe66", "departmentName": "Департамент развития", "hasChildDepartments" : true, "departmentHead": { "headID": "179bda2e-6d55-4ed5-b1be-890ffad280ba", "headName": "Петров П.П." } } ], "positions": [ { "positionID": "dc890ecf-e340-4ada-b7e6-d6541486a599", "positionName": "Маркетолог", "code": "shifr2", "pointerCode": "code2", "employees": [ { "employeeID": "f40b665c-f1f4-40b3-bdc5-291911def539", "employeeName": "Попов П.В." }, { "employeeID": "22cc3118-3bcd-4543-98b4-a30982ba5c2a", "employeeName": "Сидоров С.В." }, { "employeeID": "414acd59-aaf8-4202-8c00-b39e1fe73bbc", "employeeName": "Орлов О.О." } ] }, { "positionID": "2d9a641d-178c-4b05-b2f4-a231958718fd", "positionName": "Финансовый аналитик", "code": "shifr1", "pointerCode": "code1", "employees": [ { "employeeID": "c4ddd6b1-ade2-4ee2-ace5-aaec6a81d02a", "employeeName": "Мартынов М.М." }, { "employeeID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "employeeName": "Быков Г.Г." } ] }, { "positionID": "22a48f88-199a-4398-8eb6-15ba8ef35deb", "positionName": "Юрист", "code": "shifr3", "pointerCode": "code3", "employees": [ { "employeeID": "a2ba229b-366f-4d9c-b8bd-31742a7a519a", "employeeName": "Мусина А.М." }, { "employeeID": "a5b67a57-bcba-4513-bc2d-089400457a53", "employeeName": "Дарбаева Г.Г." }, { "employeeID": "ca936f83-3d4e-4c09-b393-9e548d18bc04", "employeeName": "Жакин Н.Б." }, { "employeeID": "ff666f77-7ii8-5b09-o565-2f555v33qq11", "employeeName": "Васильев Г.В." } ] } ] } ]
departments - массив подотделов данного департамента:
departmentID - UUID подразделения
departmentName - название подотдела на языке локали, переданной в параметре locale
hasChildDepartments - есть ли дочерние департаменты
pointerCode - код для показателей департамента
departmentHead - руководитель подотдела:
headID - UUID руководителя
headName - Ф.И.О. руководителя в формате "Фамилия И.О."
positions - массив должностей данного департамента:
positionID - UUID должности
positionName - название должности на языке локали, переданной в параметре locale
pointerCode - код для показателей должности
code - шифр должности
type - тип должности
employees - массив сотрудников на данной должности:
employeeID - UUID сотрудника
employeeName - Ф.И.О. сотрудника в формате "Фамилия И.О."
public java.lang.String getDepartmentCards(java.lang.String departmentID, java.lang.String locale)
Возвращает список дополнительных карточек для данного подразделения
URL rest/api/departments/get_cardsdepartmentID
- UUID подразделенияlocale
- локаль пользователяAPIFormsService.save(String, String, String, String, String, String)
public java.lang.String getDepartmentsByFieldValue(java.lang.String formUUID, java.lang.String formCode, java.lang.String fieldName, java.lang.String value, java.lang.String locale)
ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный
Находит подразделения по значению поля дополнительной карточки и возвращает список их идентификаторов
URL rest/api/departments/get_by_field_value
Method GET
Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы). В дополнительной карточке подразделения может храниться идентификатор соответствующего подразделения в сторонней системе, этот метод позволит найти идентификатор подразделения в нашей системе по его идентификатору из сторонней системы
Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).
Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.
formUUID
- uuid формы, по полю которой необходимо произвести поискformCode
- code формы, по полю которой необходимо произвести поискfieldName
- название поля, по которому необходимо произвести поискvalue
- значение поляlocale
- локаль пользователяpublic java.lang.String getUserID()
public Response searchDepartments(java.util.List<java.lang.String> codes, java.util.List<java.lang.String> names, int recordsCount, int startRecord, java.lang.String codeSearchTypeP, java.lang.String nameSearchTypeP, java.lang.String deleted, java.lang.String locale)
Метод поиска подразделений
URL: /rest/api/departments/search
Тип: GET
Метод принимает следующие параметры:
name
- название подразделения (необяз.), может быть передано несколько значенийpointer_code
- код показателя (необяз.), может быть передано несколько значенийrecordsCount
- количество результатов, которые необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100startRecord
- номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)searchTypeN
- тип сравнения для параметра name
(по умолчанию partial). Может принимать следующие значения:
exact
- точное совпадение поискового запроса и значения поляpartial
- вхождение поискового запроса в значение поляsearchTypePC
- тип сравнения для параметра pointer_code (по умолчанию exact). Может принимать следующие значения:
exact
- точное совпадение поискового запроса и значения поляpartial
- вхождение поискового запроса в значение поляdeleted
- включать ли в результат поиска удаленные департаменты. Допустимые значения: true или falselocale
- локаль пользователя. Данный параметр учитывается при поиске по названию должностиВ случае успешного выполнения метод возвращает массив строк, являющихся идентификаторами подразделений.
Пример запроса:
/rest/api/departments/search?pointer_code=dep1&pointer_code=dep3
Пример возвращаемого ответа:
[ "rgg66d1-ad54-5462-aef5-aggrr55fd02a", "vgikwj4c6-88gh-ef44-3ffe-oepjfee5d6" ]
При указании одновременно разных параметров результат запроса будет связан логическим И.
Пример запроса: /rest/api/departments/search?pointer_code=dep5&name=Департамент5
А при указании одновременно одинаковых параметров, результат будет производится по логическому ИЛИ.
Пример запроса: /rest/api/departments/search?pointer_code=code1&pointer_code=code2
В случае если по переданным входным параметрам ничего не найдено, сервер возвращает пустой массив.
public class UsersService
extends java.lang.Object
User: topa Date: 03.05.13 Time: 17:52
Modifier and Type | Class and Description |
---|---|
static class |
UsersService.ChangeAuthTypes |
Constructor and Description |
---|
UsersService() |
Modifier and Type | Method and Description |
---|---|
Response |
changeCredentials(java.lang.String login,
java.lang.String password,
java.lang.String passwordConfirm,
java.lang.String actionCode,
java.lang.String locale)
API для изменение логина или пароля текущего пользователя.
|
java.lang.String |
checkExistence(java.lang.String login,
java.lang.String code,
java.lang.String mail,
boolean loadData,
java.lang.String term)
Метод проверки существования пользователя
URL rest/api/filecabinet/user/checkExistence
Method GET |
java.lang.String |
createUser(java.lang.String lastname,
java.lang.String firstname,
java.lang.String patronymic,
java.lang.String iin,
java.lang.String pointersCode,
boolean isChancellery,
boolean isConfigurator,
boolean isAdmin,
java.lang.String email,
java.lang.String jid,
java.lang.String privateFolder,
boolean hasAccess,
boolean hasPrivateFolder,
java.util.List<java.lang.String> hrDepartmentID,
java.lang.String userID,
java.lang.String login,
java.lang.String password,
boolean accessMobile,
java.lang.String locale)
Метод создает/изменяет пользователя
URL rest/api/filecabinet/user/save
Method POST |
java.lang.String |
deleteUser(java.lang.String userID,
java.lang.String locale)
Метод удаляет пользователя из системы
URL rest/api/filecabinet/user/delete
Method GET |
static PersonAndGroupJson |
getPersonInfo(java.lang.String userID,
java.lang.String locale,
boolean getGroups) |
Response |
getUser(java.lang.String userID,
java.lang.String locale,
boolean getGroups)
Load and return basic iformation on user as json object
|
Response |
getUserContacts(java.lang.String userID,
java.lang.String locale)
Список контактов пользователя
|
java.lang.String |
getUserID() |
static Response |
getUserInner(java.lang.String userId,
java.lang.String locale,
boolean getGroups) |
java.lang.String |
getUsersByFieldValue(java.lang.String formUUID,
java.lang.String formCode,
java.lang.String fieldName,
java.lang.String value,
java.lang.String locale)
ВНИМАНИЕ!
|
public Response getUser(java.lang.String userID, java.lang.String locale, boolean getGroups)
public static Response getUserInner(java.lang.String userId, java.lang.String locale, boolean getGroups)
public static PersonAndGroupJson getPersonInfo(java.lang.String userID, java.lang.String locale, boolean getGroups) throws java.lang.Exception
java.lang.Exception
public Response getUserContacts(java.lang.String userID, java.lang.String locale)
userID
- uuid пользователяlocale
- локальpublic java.lang.String createUser(java.lang.String lastname, java.lang.String firstname, java.lang.String patronymic, java.lang.String iin, java.lang.String pointersCode, boolean isChancellery, boolean isConfigurator, boolean isAdmin, java.lang.String email, java.lang.String jid, java.lang.String privateFolder, boolean hasAccess, boolean hasPrivateFolder, java.util.List<java.lang.String> hrDepartmentID, java.lang.String userID, java.lang.String login, java.lang.String password, boolean accessMobile, java.lang.String locale)
Метод создает/изменяет пользователя
URL rest/api/filecabinet/user/savelastname
- фамилия, FormParamfirstname
- имя, FormParampatronymic
- отчество, FormParampointersCode
- код показателя, FormParamisChancellery
- является ли сотрудником канцелярии, FormParamisConfigurator
- является ли методологом, FormParamisAdmin
- является ли администратором системы, FormParamemail
- почтовый адрес для уведомлений, FormParamjid
- адрес jabber аккаунта, FormParamprivateFolder
- личная папка, FormParamhasAccess
- имеет ли доступ в систему, FormParamhrDepartmentID
- UUID подразделений, в которых является сотрудником ОКК, FormParamuserID
- идентификатор пользователя. Необходимо передавать если должно выполниться изменение
существующего пользователяhasPrivateFolder
- создавать ли личную папку пользователя. Имеет смысл только при создании пользователяlocale
- локаль пользователя, QueryParampublic Response changeCredentials(java.lang.String login, java.lang.String password, java.lang.String passwordConfirm, java.lang.String actionCode, java.lang.String locale)
API для изменение логина или пароля текущего пользователя.
URL rest/api/filecabinet/user/changeCredentialslogin
- новый логин, x-www-form-urlencodedpassword
- новый пароль, x-www-form-urlencodedpasswordConfirm
- подтвержение нового пароля, x-www-form-urlencodedactionCode
- тип дейтсвия. CHANGE_ALL - смена логина и пароля, CHANGE_LOGIN - смена логина, CHANGE_PASSWORD - смена пароля. x-www-form-urlencodedlocale
- локаль, x-www-form-urlencodedpublic java.lang.String deleteUser(java.lang.String userID, java.lang.String locale)
Метод удаляет пользователя из системы
URL rest/api/filecabinet/user/deleteuserID
- UUID пользователя, которого надо удалить (QueryParam)locale
- локаль пользователя, выполняющего действие (QueryParam)public java.lang.String checkExistence(java.lang.String login, java.lang.String code, java.lang.String mail, boolean loadData, java.lang.String term)
Метод проверки существования пользователя
URL rest/api/filecabinet/user/checkExistencelogin
- логин пользователя (QueryParam)code
- код пользователя (QueryParam)mail
- код пользователя (QueryParam)public java.lang.String getUsersByFieldValue(java.lang.String formUUID, java.lang.String formCode, java.lang.String fieldName, java.lang.String value, java.lang.String locale)
ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный
Находит пользователей по значению поля дополнительной карточки и возвращает список их идентификаторов
URL rest/api/filecabinet/get_by_field_value
Method GET
Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации пользователей ARTA Synergy с пользователями сторонней системы). В дополнительной карточке пользователя может храниться идентификатор соответствующего пользователя в сторонней системе (или иное поле, присутствующее в обоих системах и позволяющее установить соответствие между пользователями, например, ИИН) этот метод позволит найти идентификатор пользователя в нашей системе по его идентификатору из сторонней системы
Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).
Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.
formUUID
- uuid формы, по полю которой необходимо произвести поискformCode
- uuid формы, по полю которой необходимо произвести поискfieldName
- название поля, по которому необходимо произвести поискvalue
- значение поляlocale
- локаль пользователяpublic java.lang.String getUserID()
public class PositionsService
extends java.lang.Object
Содержит методы для управления должностями, назначением на должности
Constructor and Description |
---|
PositionsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
appointAssistant(java.lang.String nameRu,
java.lang.String nameKz,
java.lang.String nameEn,
int number,
java.lang.String departmentID,
java.util.List<java.lang.String> childDepartmentID,
java.lang.String userID,
java.lang.String locale)
Метод создает должность заместителя подразделения и назначает на него пользователя
URL rest/api/positions/assistant/appoint
Method POST |
java.lang.String |
appointToPosition(java.lang.String positionID,
java.lang.String userID,
java.lang.String locale)
Метод назначает на должность специалиста/руководителя подразделения
URL rest/api/positions/appoint
Method GET |
java.lang.String |
deleteAssistant(java.lang.String assistantID,
java.lang.String locale)
Метод удаляет должность заместителя и увольняет с нее назначенного пользователя
URL rest/api/positions/assistant/delete
Method GET |
java.lang.String |
deletePosition(java.lang.String positionID,
java.lang.String locale)
Метод удаляет должность специалиста
URL rest/api/positions/delete
Method GET |
java.lang.String |
dischargeFromPosition(java.lang.String positionID,
java.lang.String userID,
java.lang.String locale)
Метод снимает с должности специалиста/руководителя подразделения
URL rest/api/positions/discharge
Method GET |
java.lang.String |
getAssistants(java.lang.String departmentID,
java.lang.String locale)
Возвращает информацию о заместителях руководителя подразделения
URL rest/api/positions/assistant/get
Method GET |
java.lang.String |
getPosition(java.lang.String positionID,
java.lang.String locale)
Метод возвращает информацию о должности
URL rest/api/positions/get
Method GET |
java.lang.String |
getPositionCards(java.lang.String positionID,
java.lang.String locale)
Возвращает список дополнительных карточек для данной должности
URL rest/api/positions/get_cards
Method GET Для заполнения полей карточки надо использовать метод APIFormsService#save |
java.lang.String |
getPositionsByFieldValue(java.lang.String formUUID,
java.lang.String formCode,
java.lang.String fieldName,
java.lang.String value,
java.lang.String locale)
ВНИМАНИЕ!
|
Response |
getPositionsWithCards(java.lang.String departmentID,
int startRecord,
int recordsCount,
java.lang.String locale)
Метод для получения информации о должностях департамента с карточками
URL /rest/api/positions/getPositionsWithCards
Method GET Можно указать несколько компонентов для каждой карточки. |
java.lang.String |
getUserID() |
java.lang.String |
saveAssistant(java.lang.String nameRu,
java.lang.String nameKz,
java.lang.String nameEn,
int number,
java.lang.String departmentID,
java.util.List<java.lang.String> childDepartmentID,
java.lang.String userID,
java.lang.String assistantID,
java.lang.String locale)
Метод изменяет данные заместителя руководителя
URL rest/api/positions/assistant/save
Method POST |
java.lang.String |
savePosition(java.lang.String nameRu,
java.lang.String nameKz,
java.lang.String nameEn,
java.lang.String pointersCode,
java.lang.String departmentID,
java.lang.String positionID,
int positionType,
int number,
java.lang.String locale)
Метод создает/изменяет должность (специалиста/руководителя) орг структуры
URL rest/api/positions/save
Method POST |
Response |
searchPositions(java.util.List<java.lang.String> pointerCodes,
java.lang.String pointerCodeSearchTypeP,
java.util.List<java.lang.String> names,
java.lang.String nameSearchTypeP,
java.util.List<java.lang.String> codes,
java.lang.String codeSearchTypeP,
java.lang.String deleted,
int recordsCount,
int startRecord,
java.lang.String locale)
Метод поиска должностей
URL: /rest/api/positions/search
Тип: GET
Метод принимает следующие параметры:
name - название должности (необяз.), может быть передано несколько значений
code - шифр должности (необяз.), может быть передано несколько значений
pointer_code - код показателя (необяз.), может быть передано несколько значений
recordsCount - количество результатов, которые необходимо вернуть (по умолчанию 30). |
Response |
searchPositionWithCardFields(int startRecord,
int recordsCount,
boolean showAll,
boolean showOnlyVacant,
java.lang.String locale,
java.lang.String userID,
java.lang.String search,
java.lang.String departmentID,
java.lang.String filterDepartmentID,
java.lang.String filterUserID,
java.lang.String formID,
java.util.List<java.lang.String> cmpIds)
получение списка должностей с полями карточек
url: /rest/api/positions/searchPositionWithCardFields method : GET startRecord - по умолчанию 0 recordsCount - по умолчанию 30 locale - локаль departmentID идентификатора департамент чьи дочерние должности (всю иерархию) нужно вернуть search параметр текстового поиска showAll - false по умолчанию; отображать все должности (false - отображать подчиненные должности) showOnlyVacant - false по умолчанию, отображать только вакантные должности (по ним определяется максимальный уровень иерархии верх который нужно отображать и подчиненные должности) userID пользователь от имени которого выполнять поиск filterDepartmentID идентификатор непосредственного родительского подразделения filterUserID идентификатор пользователя чьи должности необходимо показать formID идентификатор формы поля карточки которой нужно поднять cmpId идентификаторы полей (можно передавать несколько cmpId=id1&cmpId=id2&cmpId=id3 и так далее) |
public java.lang.String savePosition(java.lang.String nameRu, java.lang.String nameKz, java.lang.String nameEn, java.lang.String pointersCode, java.lang.String departmentID, java.lang.String positionID, int positionType, int number, java.lang.String locale)
Метод создает/изменяет должность (специалиста/руководителя) орг структуры
URL rest/api/positions/savenameRu
- Название должности на русском языке, FormParamnameKz
- Название должности на казахском языке, FormParamnameEn
- Название должности на английском языке, FormParampointersCode
- код показателя, FormParampositionID
- UUID должности, FormParamdepartmentID
- UUID родительского подразделения, FormParampositionType
- тип должности, FormParamnumber
- порядковый номер дожности, может отсутствовать, FormParamlocale
- локаль, QueryParampublic java.lang.String deletePosition(java.lang.String positionID, java.lang.String locale)
Метод удаляет должность специалиста
URL rest/api/positions/deletepositionID
- UUID должности, которую необходимо удалить (QueryParam)locale
- локаль (QueryParam)public java.lang.String getPosition(java.lang.String positionID, java.lang.String locale)
Метод возвращает информацию о должности
URL rest/api/positions/getpositionID
- UUID должности (QueryParam)locale
- локаль (QueryParam)public Response getPositionsWithCards(java.lang.String departmentID, int startRecord, int recordsCount, java.lang.String locale)
Метод для получения информации о должностях департамента с карточками
URL /rest/api/positions/getPositionsWithCardsdepartmentID
- идентификатор подразделения, должности которого необходимо вернуть;
recursive
- флаг рекурсивности поиска должностей (по умолч. false, необязательный):
cmpIsNeeded
- флаг необходимости возврата полей карточки (по умолч. true, не обязательный). Принимает значения:
positionFormID
- идентификатор карточки должностей, данные которой необходимо вернуть,обязателен, если в запросе не указан параметр cmpIsNeeded=false;
positionFormCode
- код карточки должностей, данные которой необходимо вернуть,обязателен, если в запросе не указан параметр cmpIsNeeded=false;
cmpID
- идентификатор элемента формы, информацию из которого необходимо вернуть. Может быть передано несколько значений, обязателен, если в запросе не указан параметр cmpIsNeeded=false;startRecord
- номер записи результатов, начиная с которой будут возвращены записи(по умолчанию 0, не обязательный);recordsCount
- количество результатов, которые необходимо вернуть (по умолчанию 30, максимум 50, не обязательный);locale
- локаль;Пример возвращаемого массива:
[ { "positionID": "81ac53f0-c351-11e5-ab17-1e88d1bc0767", "positionName": "Водитель", "positionType": "256", "forms":[ { "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"41fd8240-b822-11e5-8630-525400bb7fc6", "values":[ { "category":"2" }, { "rang":"5" } ] }, { "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"182eeca0-d98e-11e5-8c91-525400bb7fc6", "values":[ { "group":"основная" } ] }, { "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"45dg8240-b822-11e5-8630-525400bb7fc6", "values":[ { "text":"Добавить в штатное расписание" }, { "date":"2016-05-02" } ] } ] }, { "positionID": "693616c0-d49b-11e5-a5fb-1e88d1bc0767", "positionName": "Водитель", "positionType": "2", "forms":[ { "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"c952f930-cfd5-11e5-bae8-525400bb7fc6", "values":[ { "category":"3" }, { "rang":"7" } ] }, { "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"1d8b0c40-91dd-11e5-9fa7-525400bb7fc6", "values":[ { "group":"вспомогательная" } ] }, { "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"26lg8240-25jz-11e5-8630-525400bb7fc6", "values":[ { "text":"Есть в штатном расписании" }, { "date":"2015-06-02" } ] } ] }, { "positionID": "ccee5340-c991-11e5-afba-1e88d1bc0767", "positionName": "Водитель", "positionType": "2", "forms":[ { "formUUID":"373c3270-cf0b-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"822ac240-b428-11e5-8630-525400bb7fc6", "values":[ { "category":"2" }, { "rang":"6" } ] }, { "formUUID":"23727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"39877130-9f17-11e5-9ae6-525400bb7fc6", "values":[ { "group":"обслуживающая" } ] }, { "formUUID":"13727710-cf22-11e5-a154-1e88d1bc0767", "formCode":"form_code", "asfDataUUID":"d66dd140-b822-11e5-8630-525400bb7fc6", "values":[ { "text":"Добавить в штатное расписание" }, { "date":"2016-02-15" } ] } ] } ]
В случае передачи неверных параметров или внутренней ошибки сервера будет возвращен массив следующего содержания (сообщение об ошибке будет менятся):
{ "errorCode": 13, "errorMessage": "Передан некорректный параметр departmentID" }Код ответа для внутренней ошибки - HTTP 500(INTERNAL_SERVER_ERROR), для неверных параметров - HTTP 400(BAD_REQUEST)
public java.lang.String appointToPosition(java.lang.String positionID, java.lang.String userID, java.lang.String locale)
Метод назначает на должность специалиста/руководителя подразделения
URL rest/api/positions/appointpositionID
- UUID должности на которую надо назначить специалиста (QueryParam)userID
- UUID пользоватля, которого надо назначить на должность (QueryParam)locale
- локаль пользователя, вызвавшего метод (QueryParam)public java.lang.String dischargeFromPosition(java.lang.String positionID, java.lang.String userID, java.lang.String locale)
Метод снимает с должности специалиста/руководителя подразделения
URL rest/api/positions/dischargepositionID
- UUID должности (QueryParam)userID
- UUID пользователя, которого надо снять с должности positionID (QueryParam)locale
- локаль пользователя, вызвавшего метод (QueryParam)public java.lang.String appointAssistant(java.lang.String nameRu, java.lang.String nameKz, java.lang.String nameEn, int number, java.lang.String departmentID, java.util.List<java.lang.String> childDepartmentID, java.lang.String userID, java.lang.String locale)
Метод создает должность заместителя подразделения и назначает на него пользователя
URL rest/api/positions/assistant/appointnameRu
- название должности на русском языке (FormParam)nameKz
- название должности на казахском языке (FormParam)nameEn
- название должности на русском языке (FormParam)departmentID
- UUID родительского департамента (FormParam)childDepartmentID
- UUID-ы дочерних подразделений (FormParam)userID
- UUID пользователя которого надо назначить на должность (FormParam)number
- порядковый номер для сортировки (по умолчанию 0) (FormParam)locale
- локаль пользователя, вызвавшего метод (QueryParam)public java.lang.String saveAssistant(java.lang.String nameRu, java.lang.String nameKz, java.lang.String nameEn, int number, java.lang.String departmentID, java.util.List<java.lang.String> childDepartmentID, java.lang.String userID, java.lang.String assistantID, java.lang.String locale)
Метод изменяет данные заместителя руководителя
URL rest/api/positions/assistant/savenameRu
- название должности на русском языке (FormParam)nameKz
- название должности на казахском языке (FormParam)nameEn
- название должности на русском языке (FormParam)departmentID
- UUID родительского департамента (FormParam)childDepartmentID
- UUID-ы дочерних подразделений (FormParam)userID
- UUID пользователя которого надо назначить на должность (FormParam)number
- порядковый номер для сортировки (по умолчанию 0) (FormParam)assistantID
- идентификатор заместителя (FormParam)locale
- локаль пользователя, вызвавшего метод (QueryParam)public java.lang.String getAssistants(java.lang.String departmentID, java.lang.String locale)
Возвращает информацию о заместителях руководителя подразделения
URL rest/api/positions/assistant/getdepartmentID
- идентификатор подразделения, для которого необходимо получить заместителейlocale
- локаль пользователяFileCabinetWrapper#getAssistantJson(arta.synergy.web.common.client.data.filecabinet.Assistant)
public java.lang.String deleteAssistant(java.lang.String assistantID, java.lang.String locale)
Метод удаляет должность заместителя и увольняет с нее назначенного пользователя
URL rest/api/positions/assistant/deleteassistantID
- UUID должности заместителяlocale
- локаль пользователя, вызвавшего методpublic java.lang.String getPositionCards(java.lang.String positionID, java.lang.String locale)
Возвращает список дополнительных карточек для данной должности
URL rest/api/positions/get_cardspositionID
- uuid должностиlocale
- локаль пользователяAPIFormsService#save(String, String, String, boolean, String)
public java.lang.String getPositionsByFieldValue(java.lang.String formUUID, java.lang.String formCode, java.lang.String fieldName, java.lang.String value, java.lang.String locale)
ВНИМАНИЕ! Логика данного метода реализована некорректно, поэтому не рекомендуем его использовать. В скором времени метод будет заменен на правильный
Находит должности по значению поля дополнительной карточки и возвращает список их идентификаторов
URL rest/api/positions/get_by_field_value
Method GET
Предполагается, что данный метод будет использоваться для реализации интеграционных решений (синхронизации орг структуры ARTA Synergy с орг структурой сторонней системы). В дополнительной карточке должности может храниться идентификатор соответствующей должности в сторонней системе, этот метод позволит найти идентификатор должности в нашей системе по ее идентификатору в сторонней системы
Поиск производится по сначала по ключу, а в случае отсутствия ключа - по значению (key и value из данных компонента, /api/asforms/data/{dataUUID}).
Для компонента "Переключатель вариантов" это порядок обратный, сначала по value, затем - по key. Надо учитывать, что в этом компоненте из-за особенностей реализации в key хранится название вариантов, а в value - значение.
formUUID
- идентификатор формыformCode
- код формыfieldName
- название поляvalue
- значение поляlocale
- локаль пользователяpublic java.lang.String getUserID()
public Response searchPositions(java.util.List<java.lang.String> pointerCodes, java.lang.String pointerCodeSearchTypeP, java.util.List<java.lang.String> names, java.lang.String nameSearchTypeP, java.util.List<java.lang.String> codes, java.lang.String codeSearchTypeP, java.lang.String deleted, int recordsCount, int startRecord, java.lang.String locale)
Метод поиска должностей
URL: /rest/api/positions/search
Тип: GET
Метод принимает следующие параметры:
name
- название должности (необяз.), может быть передано несколько значенийcode
- шифр должности (необяз.), может быть передано несколько значенийpointer_code
- код показателя (необяз.), может быть передано несколько значенийrecordsCount
- количество результатов, которые необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100startRecord
- номер записи результатов, начиная с которой будут возвращены записи (по умолчанию 0)searchTypeN
- тип сравнения для параметра name
(по умолчанию partial). Может принимать следующие значения:
exact
- точное совпадение поискового запроса и значения поляpartial
- вхождение поискового запроса в значение поляsearchTypeC
- тип сравнения для параметра code
(по умолчанию partial). Может принимать следующие значения:
exact
- точное совпадение поискового запроса и значения поляpartial
- вхождение поискового запроса в значение поляsearchTypePC
- тип сравнения для параметра pointer_code (по умолчанию exact). Может принимать следующие значения:
exact
- точное совпадение поискового запроса и значения поляpartial
- вхождение поискового запроса в значение поляdeleted
- включать ли в результат поиска удаленные должности. Допустимые значения: true или falselocale
- локаль пользователя. Данный параметр учитывается при поиске по названию должностиВ случае успешного выполнения метод возвращает массив строк, являющихся идентификаторами должностей.
Пример запроса:
/rest/api/positions/search?name=Администратор&name=Менеджер
Пример возвращаемого ответа:
[ "rgg66d1-ad54-5462-aef5-aggrr55fd02a", "vgikwj4c6-88gh-ef44-3ffe-oepjfee5d6" ]
При указании одновременно разных параметров результат запроса будет связан логическим И.
Пример запроса: /rest/api/positions/search?pointer_code=dep5&code=TRJ163
А при указании одновременно одинаковых параметров, результат будет производится по логическому ИЛИ.
Пример запроса: /rest/api/positions/search?name=Админ&name=Ассистент
В случае если по переданным входным параметрам ничего не найдено, сервер возвращает пустой массив.
public Response searchPositionWithCardFields(int startRecord, int recordsCount, boolean showAll, boolean showOnlyVacant, java.lang.String locale, java.lang.String userID, java.lang.String search, java.lang.String departmentID, java.lang.String filterDepartmentID, java.lang.String filterUserID, java.lang.String formID, java.util.List<java.lang.String> cmpIds)
public class AccessForbiddenServlet
extends HttpServlet
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
WWW_AUTHENTICATE
наименование хедера мы меняем этот хедер чтобы браузер не показывал свое окошко с вводом логина и пароля
|
static java.lang.String |
WWW_AUTHENTICATE_VALUE |
Constructor and Description |
---|
AccessForbiddenServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
service(HttpServletRequest httpServletRequest,
HttpServletResponse httpServletResponse) |
public static final java.lang.String WWW_AUTHENTICATE
public static final java.lang.String WWW_AUTHENTICATE_VALUE
public class ReportService
extends java.lang.Object
Constructor and Description |
---|
ReportService() |
Modifier and Type | Method and Description |
---|---|
Response |
getReport(java.lang.String fileName,
java.lang.String reportID,
java.lang.String reportCode,
java.lang.String parentIdentifier,
java.lang.Boolean inline)
Метод позволяет получить результат выполнения отчета для пользователя.
|
java.lang.String |
getReportListForUser()
Метод позволяет получить информацию о доступных текущему пользователю отчетов.
|
public java.lang.String getReportListForUser()
public Response getReport(java.lang.String fileName, java.lang.String reportID, java.lang.String reportCode, java.lang.String parentIdentifier, java.lang.Boolean inline)
fileName
- - требуемое имя файла. Если имя файла не было передано то будет использовано имя файла по умолчанию.reportID
- - идентификатор отчетаreportCode
- - код отчетаparentIdentifier
- - идентификатор папки для сохранения отчетаinline
- - тип передачи (true - inline/false - attachment)public class OcspService
extends java.lang.Object
Constructor and Description |
---|
OcspService() |
Modifier and Type | Method and Description |
---|---|
java.util.List<OcspStatus> |
verify(CertWrapper cert,
CertWrapper issuer)
Проверяет статус заданного сертификата с использованием OCSP.
|
public java.util.List<OcspStatus> verify(CertWrapper cert, CertWrapper issuer)
cert
- объект CertWrapper
, представляющий проверяемый сертификат.issuer
- объект CertWrapper
, представляющий корневой сертификат (сертификат издателя).OcspStatus
, содержащих результаты проверки.
Если сертификат издателя не найден, возвращается статус OcspResult.UNKNOWN
.public class DigitalSignatureService
extends java.lang.Object
Constructor and Description |
---|
DigitalSignatureService() |
Modifier and Type | Method and Description |
---|---|
void |
invalidateEdsToken(java.lang.String userID,
java.lang.String token) |
CertificateInfo |
registerEDS(EDS eds)
Регистрирует пользователя исходя из полученной информации из сертификата EDS, выполняя его проверку и валидацию.
|
UserInfoIdentifierDTO |
sigIn(EDS eds,
boolean getGroups)
Выполняет вход пользователя с использованием EDS.
|
java.lang.String |
uuidForSignature()
Генерирует уникальный идентификатор UUID для использования в подписи и сохраняет его в бд для обеспечения уникальности входа.
|
public UserInfoIdentifierDTO sigIn(EDS eds, boolean getGroups) throws java.lang.Exception
eds
- объект, содержащий данные цифровой подписи.getGroups
- отдавать ли информацию о группах пользователяjava.lang.Exception
- если произошла ошибка при обработке.public CertificateInfo registerEDS(EDS eds) throws java.lang.Exception
eds
- объект, содержащий данные цифровой подписи.CertificateInfo
.java.lang.Exception
- если произошла ошибка при проверке или обработке.public java.lang.String uuidForSignature() throws java.lang.Exception
java.lang.Exception
- если произошла ошибка при сохранении UUID.public void invalidateEdsToken(java.lang.String userID, java.lang.String token) throws java.lang.Exception
java.lang.Exception
public class DirectoryService
extends java.lang.Object
Constructor and Description |
---|
DirectoryService() |
Modifier and Type | Method and Description |
---|---|
java.util.Optional<java.io.File> |
getCachePathFor(java.lang.String dirName)
Возвращает путь к кэшу.
|
public class FileDownloadServlet
extends DefaultHttpServlet
Constructor and Description |
---|
FileDownloadServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest req,
HttpServletResponse res) |
public class StorageGroupsService
extends java.lang.Object
Constructor and Description |
---|
StorageGroupsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addUserToGroup(java.lang.String userID,
int groupID,
java.lang.String groupCode,
java.lang.String locale)
Метод добавляет пользователя в группу
URL rest/api/storage/groups/add_user
Method GET |
java.lang.String |
getGroups(java.lang.String locale,
int startRecord,
int recordsCount)
Метод возвращает список групп
URL rest/api/storage/groups/list
Method GET |
java.lang.String |
getUserID() |
java.lang.String |
removeUserFromGroup(java.lang.String userID,
int groupID,
java.lang.String groupCode,
java.lang.String locale)
Удаляет пользователя из группы
URL rest/api/storage/groups/remove_user
Method GET |
public java.lang.String addUserToGroup(java.lang.String userID, int groupID, java.lang.String groupCode, java.lang.String locale)
Метод добавляет пользователя в группу
URL rest/api/storage/groups/add_useruserID
- идентификатор пользователяgroupID
- идентификатор группыgroupCode
- код группыlocale
- public java.lang.String removeUserFromGroup(java.lang.String userID, int groupID, java.lang.String groupCode, java.lang.String locale)
Удаляет пользователя из группы
URL rest/api/storage/groups/remove_useruserID
- идентификатор пользователяgroupID
- идентификатор группыgroupCode
- код группыlocale
- public java.lang.String getGroups(java.lang.String locale, int startRecord, int recordsCount)
Метод возвращает список групп
URL rest/api/storage/groups/listlocale
- локаль авторизованного пользователяstartRecord
- номер первой записиrecordsCount
- количество записей в спискеpublic java.lang.String getUserID()
public class PDFDownloadServlet
extends DefaultHttpServlet
Constructor and Description |
---|
PDFDownloadServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest req,
HttpServletResponse res) |
public class ASFFileServlet
extends DefaultHttpServlet
Constructor and Description |
---|
ASFFileServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest req,
HttpServletResponse res) |
protected void |
doPost(HttpServletRequest req,
HttpServletResponse res) |
java.util.Map<java.lang.String,java.lang.Object> |
getImportingForms() |
protected void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException, java.io.IOException
ServletException
java.io.IOException
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, java.io.IOException
ServletException
java.io.IOException
public java.util.Map<java.lang.String,java.lang.Object> getImportingForms()
public class IconServlet
extends HttpServlet
Constructor and Description |
---|
IconServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest request,
HttpServletResponse response) |
static void |
init(ServletContext cnxt) |
public class StorageService
extends java.lang.Object
Constructor and Description |
---|
StorageService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
add(java.lang.String folderID,
java.lang.String path,
java.lang.String name,
java.lang.String locale)
Метод используется для добавления файла в хранилище
Тип: POST
URL: rest/api/storage/add
|
Response |
addFile(java.lang.String dataUUID,
java.lang.String filePath,
java.lang.String fileName,
boolean overwrite)
добавляет загруженный на сервер файл в файл по форме
Path rest/api/storage/asffile/addFile
|
Response |
addVersion(VersionFile versionFile)
Загрузка новой версии файла на сервер
URL: rest/api/storage/add/version Тип: POST { "fileId": "b7b469fa-62de-4462-adbd-f51d03dc854", "path": "/opt/synergy/jboss/standalone/tmp/Synergy/upload.tmp/516408e9-7094-45df-8ae7-e077b4d8daa2", "compareHash": false } |
Response |
asfFile(MultipartFormDataInput input,
java.lang.String nodeID,
java.lang.String dataUUID)
загрузка файла в файл по форме (для реквестов более 2-х мегабайт работать не будет)
Path rest/api/storage/asffile/upload
|
Response |
canEditAsfData(java.lang.String documentId) |
Response |
copy(java.util.Map<java.lang.String,java.lang.String> params)
копировать файл из хранилища в файл по форме
Path rest/api/storage/asffile/copy
|
java.lang.String |
copy(java.lang.String fileID,
java.lang.String documentID,
java.lang.String container,
java.lang.String locale)
Метод используется для копирования файла из хранилища в документ
Тип: POST
URL: rest/api/storage/copy
|
java.lang.String |
create(java.lang.String folderID,
java.lang.String folderName,
java.lang.String locale)
Метод используется для создания папки в хранилище
Тип: POST
URL: rest/api/storage/create
|
java.lang.String |
createAttachment(java.lang.String docID,
java.lang.String path,
java.lang.String fileName,
java.lang.String filePath,
java.lang.String locale)
Метод добавляет вложение к документу из временного файла, загруженного на сервер с помощью API хранилища
URL rest/api/storage/document/{docID}/attachment/create Method POST |
Response |
createHtd(java.util.Map<java.lang.String,java.lang.String> params) |
Response |
getDescription(java.lang.String nodeId)
Возвращает список версий
|
java.lang.String |
getDescription(java.lang.String elementID,
boolean mobile,
java.lang.String locale)
Возвращает детальную информацию папки/файла
URL: rest/api/storage/description
Тип: GET
|
java.lang.String |
getIdentifierByPath(java.lang.String path)
Получение идентификатора файла либо папки по пути
URL: rest/api/storage/get_identifier_by_path Тип: GET |
java.lang.String |
getPathToElement(java.lang.String elementID,
java.lang.String locale) |
java.lang.String |
getUserID() |
java.lang.String |
listFavoriteFolders()
Метод возвращает избранные папки в хранилище
Метод не принимает никакие параметры.
|
java.lang.String |
listFiles(java.lang.String parentID,
boolean getOnlyFolders,
java.lang.String locale)
Метод возвращает список файлов в папке с идентификатором parentID
URL rest/api/storage/list Method GET |
java.lang.String |
move(java.lang.String elementID,
java.lang.String folderID,
java.lang.String locale)
Метод используется для перемещения файла или папки в хранилище
Тип: POST
URL: rest/api/storage/move
|
java.lang.String |
remove(java.lang.String elementID,
java.lang.String locale)
Метод используется для удаления файла или папки в хранилище
Тип: POST
URL: rest/api/storage/remove
|
java.lang.String |
rename(java.lang.String elementID,
java.lang.String elementName,
java.lang.String locale)
Метод используется для переименования файла/папки в хранилище
Тип: POST
URL: rest/api/storage/rename
|
java.lang.String |
search(java.lang.String contains,
java.lang.String notContains,
java.util.List<java.lang.Integer> categoryID,
java.lang.String aiType,
java.lang.String folderID,
java.lang.String modifiedFrom,
java.lang.String modifiedTo,
int sizeType,
int sortType,
boolean includeUnpublished,
boolean includeExpired,
boolean includeCompanions,
int firstResult,
int maxResult,
java.lang.String searchArea,
java.lang.String locale)
Выполняет поиск в хранилище и возвращает список найденных файлов/папок
URL rest/api/storage/search Method POST |
java.lang.String |
startUploadFile(java.lang.String locale)
Метод создает временный файл на стороне сервера
URL rest/api/storage/start_upload Method GET Метод создает временный файл, для дальнейшего его использования в процессе загрузки файла на сервер. |
java.lang.String |
uploadPart(MultipartFormDataInput input,
java.lang.String file,
java.lang.String locale)
Дописывает байты во временный файл
URL rest/api/storage/upload_part Method POST Enctype multipart/form-data название поля формы для части файла должно называться - body |
public java.lang.String startUploadFile(java.lang.String locale)
Метод создает временный файл на стороне сервера
Метод создает временный файл, для дальнейшего его использования в процессе загрузки файла на сервер. Метод возвращает путь к созданному файлу, который необходимо использовать далее в методе upload_part
Процесс загрузки файла на сервер должен выглядить следующим образом:
locale
- локаль пользователяpublic java.lang.String uploadPart(MultipartFormDataInput input, java.lang.String file, java.lang.String locale)
Дописывает байты во временный файл
file
- имя временного файла, полученного методом startUploadFile (QueryParam)locale
- локаль пользователя (QueryParam)startUploadFile(String)
public java.lang.String getIdentifierByPath(java.lang.String path)
path
- путь до файла или папки хранилища{ "identifier": "6cacb59f-a1d6-447b-9f85-06829e942309", "is_folder": true, "size": "0", "path": "/company_root/01_", "name": "01_", "modified": "2013-05-24 16:15:03", "userName": "Admin1 Admin1 A.", "userID": "1", "right": 0, "notEmpty": true } Пример возвращаемого json для файла http://host:port/Synergy/rest/api/storage/get_identifier_by_path?path=Хранилище/01_/1.doc{ "identifier": "d2a75a06-618a-4058-a6ae-99f8440d8973", "is_folder": false, "size": "2218", "path": "/company_root/01_/1.doc", "name": "1.doc", "modified": "2014-01-28 11:05:39", "userName": "Petrov Petrov ", "userID": "a8b370ee-138a-40a6-bd32-7f6435a1b4af", "right": 0, "mime": "text/html", "ai_type": "ai_text", "icon": "rest/api/storage/icons/get?aiType=ai_text&fileName=1.doc", "notEmpty": false }
public java.lang.String listFiles(java.lang.String parentID, boolean getOnlyFolders, java.lang.String locale)
Метод возвращает список файлов в папке с идентификатором parentID
parentID
- - идентификатор папки, если не передан, то возвращаются все корневые папки,
на которые пользователь имеет право, в том числе личная папка пользователяgetOnlyFolders
- - (true/false) - отображать ли только папки (не обяз., по умолчанию значение false);locale
- - локаль пользователя[ { "identifier": "5719212b-97b9-4558-9e67-baa04d0adc62", "is_folder": true, "size": "0", "path": "/aiservice/home/ee71a4c6-888a-4f04-86de-44ab394f5749", "name": "Мои документы", "modified": "0007-05-04 10:12:00", "userName": "Слепаков Иван И.", "userID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "right": 7, }, { "identifier": "91d1816a-b30e-47ea-988c-bd8864daa253", "is_folder": true, "size": "0", "path": "/company_root", "name": "company_root", "modified": "2011-10-10 09:13:39", "userName": " ", "userID": "0000-0000-0000-0002", "right": 7, } ]Пример возвращаемого массива для файлов
[ { "identifier":"f5003070-3740-4920-a4c5-01f8bf440774", "is_folder":false, "size":"19644", "path":"/company_root/Проект/Файл1.odt", "name":"Файл1.odt", "modified":"2013-03-13 16:35:45", "userName":"Слепаков Иван И.", "userID":"ee71a4c6-888a-4f04-86de-44ab394f5749", "right":7, "mime ":"application/vnd.oasis.opendocument.text", "icon":"rest/api/storage/icons/get?aiType=ai_text&fileName=Файл1.odt" }, { "identifier":"a8bb8fba-b418-4fcb-9b86-519c261c446f", "is_folder":false, "size":"850", "path":"/company_root/Проект/Файл2.htd", "name":"Файл2.htd", "modified":"0016-05-03 03:15:00", "userName":"Слепаков Иван И.", "userID":"ee71a4c6-888a-4f04-86de-44ab394f5749", "right":7, "mime ":"text/htd", "icon":"rest/api/storage/icons/get?aiType=ai_htd&fileName=Файл2.htd" } ]
public java.lang.String listFavoriteFolders()
Метод возвращает избранные папки в хранилище
Метод не принимает никакие параметры.
В случае успешного выполнения возвращаемый json содержит, в свою очередь, список json, каждый из которых имеет следующее поле:
[ { "identifier": "5719212b-97b9-4558-9e67-baa04d0adc62" "name": "Общие документы" }, { "identifier": "91d1816a-b30e-47ea-988c-bd8864daa253" "name": "Регламенты" } ]
public java.lang.String search(java.lang.String contains, java.lang.String notContains, java.util.List<java.lang.Integer> categoryID, java.lang.String aiType, java.lang.String folderID, java.lang.String modifiedFrom, java.lang.String modifiedTo, int sizeType, int sortType, boolean includeUnpublished, boolean includeExpired, boolean includeCompanions, int firstResult, int maxResult, java.lang.String searchArea, java.lang.String locale)
Выполняет поиск в хранилище и возвращает список найденных файлов/папок
contains
- строка, которая должна содержаться в искомых файлахnotContains
- строка, которая не должна содержаться в искомых файлахcategoryID
- идентификатор классификатора, которому должны принадлежать искомые файлы. Значение данного параметра может
быть передано несколько раз.aiType
- определяет тип искомых файлов. Может быть передано значение одной из констант:
folderID
- идентификатор папки хранилища, в которой необходимо осуществить поиск. Параметр можно не передавать, в этом случае
поиск будет произведен по всем файлам, на которые у пользователя есть праваmodifiedFrom
- начало периода последнего изменения в формате yyyy-MM-dd, параметр не нужно передавать если нет необходимости выполнять поиск по дате измененияmodifiedTo
- завершение периода последнего изменения в формате yyyy-MM-dd, параметр не нужно передавать если нет необходимости выполнять поиск по дате измененияsizeType
- определяет размер искомого файла. Значением параметра может быть одно из значений констант:
sortType
- параметр определяет тип сортировки файлов. Значением параметра может быть одно из значений констант:
includeUnpublished
- отображать ли в результатах поиска неопубликованные файлы, значение по-умолчаню - нетincludeExpired
- отображать ли в результатах поиска файлы, срок действия которых истек,includeCompanions
- осуществлять ли поиск в папках документов, проектов, значение по-умолчанию - нетfirstResult
- номер первой записи для возвращаемых результатов выборки, значение по-умолчанию - 1maxResult
- количество записей, которые должны быть возвращены, значение по-умолчанию - 30locale
- локаль пользователяsearchArea
- определяет область действия поиска. Значением параметра может быть одно из значений констант:
Json каждого результата поиска имеет вид
{
"list": [] список найденных файлов
"begin": "", номер первой записи
"length": "", количество возвращенных записей
"count": "" общее количество найденных записей
}
{
identifier: идентификатор файла
ai_type: тип файла
name: название файла
path: путь к файлу
modified: стам изменения
parentID: идентификатор родительского элемента
fragments: фрагменты текста файла наиболее удовлетворяющие поиску (поле может отсутствовать)
icon_url: ссылка до иконки файла (поле может отсутствовать)
right: сумма чисел, определяющая набор прав на папку или файл
}
arta.remote.client.AIConstants#AI_FOLDER
,
arta.remote.client.AIConstants#AI_DOCUMENT
,
arta.remote.client.AIConstants#AI_IMAGE
,
arta.remote.client.AIConstants#AI_AUDIO
,
arta.remote.client.AIConstants#AI_VIDEO
,
arta.remote.client.AIConstants#AI_APPLICATION
,
arta.remote.client.AIConstants#ALL_SIZES
,
arta.remote.client.AIConstants#LITTLE
,
arta.remote.client.AIConstants#MIDDLE
,
arta.remote.client.AIConstants#BIG
,
ExtendedSearchParams#SORT_RELEVANCE
,
ExtendedSearchParams#SORT_DATE
,
ExtendedSearchParams#SORT_READSCOUNT
public java.lang.String getPathToElement(java.lang.String elementID, java.lang.String locale)
public java.lang.String getUserID()
public java.lang.String createAttachment(java.lang.String docID, java.lang.String path, java.lang.String fileName, java.lang.String filePath, java.lang.String locale)
Метод добавляет вложение к документу из временного файла, загруженного на сервер с помощью API хранилища
docID
- UUID документаpath
- строка, показывающая в какую подпапку контейнера файлов документа необходимо положить файл.
Возможные значения:
fileName
- Название загружаемого файлаfilePath
- Путь к временному файлу, загруженному на серверlocale
- локаль пользователяstartUploadFile(String)
,
StorageService#uploadPart(org.jboss.resteasy.plugins.providers.multipart.MultipartFormDataInput, String, String)
public java.lang.String remove(java.lang.String elementID, java.lang.String locale)
elementID
- идентификатор файла либо папки (обязательный параметр)locale
- локальpublic java.lang.String move(java.lang.String elementID, java.lang.String folderID, java.lang.String locale)
elementID
- идентификатор файла либо папки (что перемещаем, обязательный параметр)folderID
- идентификатор папки (куда перемещаем, обязательный параметр)locale
- локальpublic java.lang.String rename(java.lang.String elementID, java.lang.String elementName, java.lang.String locale)
elementID
- идентификатор файла либо папки (обязательный параметр)elementName
- новое имя файла либо папки (обязательный параметр)locale
- локальpublic java.lang.String create(java.lang.String folderID, java.lang.String folderName, java.lang.String locale)
folderID
- идентификатор папки, внутри которой происходит создание (обязательный параметр)folderName
- имя новой папкиlocale
- локальpublic java.lang.String copy(java.lang.String fileID, java.lang.String documentID, java.lang.String container, java.lang.String locale)
fileID
- идентификатор файла (обязательный параметр)documentID
- идентификатор документа, куда будет копироваться файл (обязательный параметр)container
- контейнер (приложения либо прочие, по умолчанию - ase:attachmentContainer)locale
- локальarta.synergy.web.common.client.data.bp.docflow.constants.DocFileType#INBOX_FILE
,
arta.synergy.web.common.client.data.bp.docflow.constants.DocFileType#WORK_FILE
public java.lang.String add(java.lang.String folderID, java.lang.String path, java.lang.String name, java.lang.String locale)
folderID
- идентификатор папки куда будет добавляться файл (обязательное поле)path
- абсолютный путь до файла (обязательное поле)name
- имя файла (обязательное поле)locale
- локальpublic java.lang.String getDescription(java.lang.String elementID, boolean mobile, java.lang.String locale)
elementID
- идентификатор папки или файла (обяз.)locale
- локаль пользователяНабор прав на папку или файл, права в системе:
READ = 1 (право на просмотр элемента) ADD = 2 (право на добавление нового элемента) DELETE = 4 (право на удаление элемента) EDIT_FOLDER_VIEW = 8 (право на редактирование index страницы папки) EDIT_DOCUMENT = 16 (право на редактирование документа) ADD_COMMENT = 32 (право на добавление комментариев) EDIT_COMMENT = 64 (право на редактирование комментариев) DELETE_COMMENT = 128 (право на удаление комментариев) READ_COMMENT = 256 (право на просмотр комментариев) READ_VERSIONS = 512 (право на просмотр версий документа) EDIT_VERSIONS = 1024 (право на восстановление версий документа) EDIT_METADATA = 2048 (право на редактирование свойств документа) READ_METADATA = 4096 (право на просмотр свойств документа) EDIT_CATEGORIES = 8192 (право на редактирование классификатора документа) READ_CATEGORIES = 16384 (право на просмотр классификатора документа) ADD_DOCUMENT_REFERENCES = 32768 (право на добавление документа в список ссылок документа) EDIT_DOCUMENT_REFERENCES = 65536 (право на редактирование списка ссылок документа) DELETE_DOCUMENT_REFERENCES = 131072 (право на удаление ссылок документа) READ_DOCUMENT_REFERENCES = 262144 (право на просмотр списка ссылок документа) LOAD_DOCUMENT = 524288 (право на загрузку файла документа) MOVE = 2097152 (право на перемещение / переименовывание элемента) CHANGE_PERMISSION = 4194304 (право на назначение прав) FULL_ACCESS = 2147483647
В случае неуспешного выполнения вовзращается json с полями:
Пример возвращаемого массива
{ "identifier": "f5003070-3740-4920-a4c5-01f8bf440774", "is_folder": false, "size": "19644", "path": "/company_root/Проект/Файл1.odt", "name": "Файл1.odt", "modified": "2013-03-13 16:35:45", "userName": "Слепаков Иван И.", "userID": "ee71a4c6-888a-4f04-86de-44ab394f5749", "right": 7, "mime ": "application/vnd.oasis.opendocument.text", "icon": "rest/api/storage/icons/get?aiType=ai_text&fileName=Файл1.odt", "parents": ["d1f91787-ac5d-4650-a7c0-1cdfbdd12165", "5860da7f-0615-4f46-8264-d8605d97ef9e"], " ai_type": "ai_document" }
public Response createHtd(java.util.Map<java.lang.String,java.lang.String> params)
public Response copy(java.util.Map<java.lang.String,java.lang.String> params)
params
- {objectId : , targetId : , dataId : }
где
objectId - идентификатор объекта
targetId - идентификатор ноды данных по форме
dataId - идентификатор данных по формеpublic Response asfFile(MultipartFormDataInput input, java.lang.String nodeID, java.lang.String dataUUID) throws java.io.IOException, javax.naming.NamingException, RepositoryException
input
- данные файлаnodeID
- идентификатор нодыdataUUID
- идентификатор данныхjava.io.IOException
javax.naming.NamingException
RepositoryException
public Response addFile(java.lang.String dataUUID, java.lang.String filePath, java.lang.String fileName, boolean overwrite)
dataUUID
- идентификатор данных по формеfilePath
- путь до загруженного файлаfileName
- имя файлаoverwrite
- перезапись файлаpublic Response canEditAsfData(java.lang.String documentId)
public Response getDescription(java.lang.String nodeId)
nodeId
- идентификатор узла (документа, файла и тд)public Response addVersion(VersionFile versionFile)
{ "fileId": "b7b469fa-62de-4462-adbd-f51d03dc854", "path": "/opt/synergy/jboss/standalone/tmp/Synergy/upload.tmp/516408e9-7094-45df-8ae7-e077b4d8daa2", "compareHash": false }
versionFile
- { "ErrorCode": "0", "fileId": "b575fbde-5a1d-49b6-8599-30c51b9dd1fc" }
public class LoggerService
extends java.lang.Object
Constructor and Description |
---|
LoggerService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
addLog(java.lang.String providerID,
int actionType,
java.lang.String log)
Метод добавляет запись в журнал логов системы
URL rest/api/logger/add Method POST Все параметры запроса должны быть параметрами формы |
java.lang.String |
getHost() |
java.lang.String |
getUserID() |
java.lang.String |
log(LogDTO log) |
java.lang.String |
start(java.util.HashMap<java.lang.String,java.lang.Object> options) |
public java.lang.String addLog(java.lang.String providerID, int actionType, java.lang.String log)
Метод добавляет запись в журнал логов системы
providerID
- идентификатор источника логовactionType
- код действияlog
- текст логаpublic java.lang.String start(java.util.HashMap<java.lang.String,java.lang.Object> options)
public java.lang.String log(LogDTO log)
public java.lang.String getHost()
public java.lang.String getUserID()
public class PersonLoad
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
PersonLoad.ReqParams |
static class |
PersonLoad.ValueResult |
Constructor and Description |
---|
PersonLoad() |
Modifier and Type | Method and Description |
---|---|
java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> |
getEfficiency(java.util.ArrayList<PersonLoad.ReqParams> params) |
Response |
getEfficiency(PersonLoad.ReqParams params) |
java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> |
getWorkload(java.util.ArrayList<PersonLoad.ReqParams> params) |
java.util.List<PersonLoad.ValueResult> |
getWorkload(PersonLoad.ReqParams params) |
public java.util.List<PersonLoad.ValueResult> getWorkload(PersonLoad.ReqParams params)
public java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> getWorkload(java.util.ArrayList<PersonLoad.ReqParams> params)
public Response getEfficiency(PersonLoad.ReqParams params)
public java.util.Map<java.lang.String,java.util.List<PersonLoad.ValueResult>> getEfficiency(java.util.ArrayList<PersonLoad.ReqParams> params)
public class PersonService
extends java.lang.Object
Constructor and Description |
---|
PersonService() |
Modifier and Type | Method and Description |
---|---|
Response |
checkExtModuleUserRights(java.lang.String moduleCode)
API проверки прав на внешний модуль
Проверяет, есть ли у авторизованного пользователя права на модуль
URL rest/api/person/check_ext_module
Method GET |
Response |
deleteUserAuthKey(java.lang.String moduleID)
удаляет ключ авторизации пользователя вне сессии
URL rest/api/person/invalidate_auth_key
Method GET |
java.lang.String |
deleteUserPhoto(java.lang.String userID,
java.lang.String locale)
Метод удаляет фотографию пользователя
URL /rest/api/person/photo/delete
Method GET |
java.lang.String |
generateUserAuthToken(java.lang.String moduleID)
генерирует ключ для авторизации пользователя вне сессии
URL rest/api/person/generate_auth_key
Method GET |
java.lang.String |
getAccountFullName(java.lang.String userID) |
Response |
getCreateMenuItems()
Возвращает доступные пользователю пункты меню кнопки "Создать".
|
java.lang.String |
getSSOHash(java.lang.String clientParams)
Метод возвращает SSOHash пользователя
URL /rest/api/person/SSOHash
Method GET |
Response |
getUser(java.lang.String locale,
boolean getGroups)
Авторизует пользователя и возвращает информацию о нем
|
Response |
getUserDepartments(java.lang.String userID,
java.lang.String userCode)
Возвращает список из ID и кодов подразделений,
к которым принадлежит этот пользователь, начиная с его непосредственного подразделения и вверх до корня
URL rest/api/person/get_user_departments
Method GET |
Response |
getUserDepartments(java.lang.String userID,
java.lang.String userCode,
java.lang.String depID,
java.lang.String depCode) |
java.lang.String |
getUserID() |
Response |
setCreateMenuItems(java.util.List<CreateMenuBookmarkDTO> bookmarks)
Метод для установки избранных пунктов выпадающего меню кнопки "Создать"
URL /rest/api/person/set_create_menu_items
Method POST Принимает массив JSON, с указанием параметров: [ { "itemID": "66679726-f0c2-4fa4-8681-04ebaf350d09", "is_bookmark": "true" } ] |
Response |
updateUserAuthKey(java.lang.String moduleID)
обновление аренды токена
URL rest/api/person/update_auth_key_expire
Method GET |
public Response getUser(java.lang.String locale, boolean getGroups)
public java.lang.String generateUserAuthToken(java.lang.String moduleID)
moduleID
- код модуляpublic Response deleteUserAuthKey(java.lang.String moduleID)
moduleID
- код модуляpublic Response checkExtModuleUserRights(java.lang.String moduleCode)
moduleCode
- код модуляpublic Response updateUserAuthKey(java.lang.String moduleID)
moduleID
- код модуляpublic java.lang.String deleteUserPhoto(java.lang.String userID, java.lang.String locale)
Метод удаляет фотографию пользователя
URL /rest/api/person/photo/deleteuserID
- UUID пользователяlocale
- локаль пользователя, выполняющего действиеpublic java.lang.String getSSOHash(java.lang.String clientParams)
Метод возвращает SSOHash пользователя
URL /rest/api/person/SSOHashclientParams
- параметр, содержащий user-agent и host пользователяpublic java.lang.String getAccountFullName(java.lang.String userID)
public Response getUserDepartments(java.lang.String userID, java.lang.String userCode)
userID
- UUID пользователяuserCode
- код пользователяpublic Response getUserDepartments(java.lang.String userID, java.lang.String userCode, java.lang.String depID, java.lang.String depCode)
userID
- UUID пользователяuserCode
- код пользователяdepID
- UUID подразделенияdepCode
- код подразделенияpublic Response getCreateMenuItems()
public Response setCreateMenuItems(java.util.List<CreateMenuBookmarkDTO> bookmarks)
Метод для установки избранных пунктов выпадающего меню кнопки "Создать"
URL /rest/api/person/set_create_menu_itemspublic java.lang.String getUserID()
public class UserPhotoServlet
extends LoadPhotoServlet
POST - добавление, изменении фотографии пользователя, параметр uploadFormElement - файл, userid - uuid пользователя, locale - локаль
GET - получение фотографии пользователя, параметр userid - uuid пользователя, max_width - макс. ширина, max_height - макс. высота
Пример получения фотографииConstructor and Description |
---|
UserPhotoServlet() |
Modifier and Type | Method and Description |
---|---|
protected void |
doGet(HttpServletRequest request,
HttpServletResponse response) |
protected void |
doPost(HttpServletRequest request,
HttpServletResponse response) |
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, java.io.IOException
ServletException
java.io.IOException
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, java.io.IOException
ServletException
java.io.IOException
public class NotificationsService
extends java.lang.Object
Constructor and Description |
---|
NotificationsService() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
get(long lastGetTime,
boolean subscribedOnly,
java.util.List<java.lang.Integer> actionType,
java.util.List<java.lang.Integer> objectType,
java.lang.String locale)
Метод возвращает уведомления для авторизованного пользователя
URL rest/api/notifications/get Method GET |
java.lang.String |
getHost() |
java.lang.String |
getUserID() |
Response |
send(NotificationSend sendInfo)
Метод API для отправки произвольного уведомления пользователю
URL: rest/api/notifications/send
Method POST Метод принимает следующие входные параметры (json): header - заголовок/тема уведомления (не обяз.); message - тело уведомления (обяз.); users - массив uuid пользователей, которым необходимо отправить уведомление; groups - массив uuid групп пользователей, которым необходимо отправить уведомление; logins - массив логинов пользователей, которым необходимо отправить уведомление; emails - массив произвольных e-mail, которым необходимо отправить уведомление; locale - локаль. |
public java.lang.String get(long lastGetTime, boolean subscribedOnly, java.util.List<java.lang.Integer> actionType, java.util.List<java.lang.Integer> objectType, java.lang.String locale)
Метод возвращает уведомления для авторизованного пользователя
lastGetTime
- Время последнего получения уведомлений в миллисекундах, если ранее уведомления не запрашивались
значние передавать не надо - система сама определит количество последних уведомлений, которые надо вернутьsubscribedOnly
- true - система вернет только те типы уведомлений на получение которых пользователь подписан, согласно
настройкам в системе, false - вернет все типы уведомленийactionType
- идентификатор типа уведомления (action_types.typeID), передача этого ограничивает возвращаемые уведомления
данным типом/типами. Если необходимо передать несколько типов уведомлений - параметр надо указать в запросе несколько разobjectType
- идентификатор объекта, передача этого параметра ограничиывает возвращаемые уведомления
по типу объекта, к которому они относятся. Если необходимо передать несколько типов объектов - параметр надо указать в запросе несколько раз
Обрабатываются значения парамтра:
locale
- локаль авторизованного пользователя
{
"lasGetTime": "yyyy-MM-dd HH:ss:mm", - стамп времени получения уведомлений
"notifications": - список уведомлений
[
{
"time":"", - время события
"notification":"" - текст уведомления
}, ...
]
public Response send(NotificationSend sendInfo)
Метод API для отправки произвольного уведомления пользователю
URL: rest/api/notifications/send
Method POST
Метод принимает следующие входные параметры (json):
header - заголовок/тема уведомления (не обяз.);
message - тело уведомления (обяз.);
users - массив uuid пользователей, которым необходимо отправить уведомление;
groups - массив uuid групп пользователей, которым необходимо отправить уведомление;
logins - массив логинов пользователей, которым необходимо отправить уведомление;
emails - массив произвольных e-mail, которым необходимо отправить уведомление;
locale - локаль.
Пример передаваемого запроса:
{
"header": "Срочное собрание!",
"message": "Прошу Вас собраться в 10:00 в актовом зале.",
"users": ["7b953be8-bddb-4ce4-bbfd-ae9548f69c7f", "e65f62fa-7045-4b5b-b61d-46ca00ea7af1"],
"groups": [1, 5, 7],
"logins": ["Абдрешен", "Слепаков", "user_100500", "1"],
"emails": ["bobrov@arta.kz"]
}
sendInfo
- json-объект;{ "errorCode": 0, "errorMessage": "Уведомление отправлено" }
public java.lang.String getHost()
public java.lang.String getUserID()
public class RegisterDocsExportService
extends java.lang.Object
Constructor and Description |
---|
RegisterDocsExportService() |
Modifier and Type | Method and Description |
---|---|
java.io.ByteArrayOutputStream |
exportToExcell(DocFilter filter,
<any> documentsList,
java.lang.String locale) |
java.lang.String |
getStatusText(GeneralDoc doc,
ArtaMessages tr) |
java.lang.String |
getValue(GeneralDoc doc,
DocumentColumnModel.Type columnType,
ArtaMessages tr) |
public java.io.ByteArrayOutputStream exportToExcell(DocFilter filter, <any> documentsList, java.lang.String locale) throws java.io.IOException
java.io.IOException
public java.lang.String getValue(GeneralDoc doc, DocumentColumnModel.Type columnType, ArtaMessages tr)
public java.lang.String getStatusText(GeneralDoc doc, ArtaMessages tr)
public class DocFlowService
extends java.lang.Object
Constructor and Description |
---|
DocFlowService() |
Modifier and Type | Method and Description |
---|---|
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
|
Response |
cleanBuffer() |
Response |
copyPrFolder(DocumentRequestDTO documentRequestDTO)
Копирует документ в личное дело пользователя.
|
Response |
create(DocumentRCC rcc) |
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
|
Response |
deleteChildDocument(java.lang.String parent_documentID,
java.lang.String child_documentID)
Метод удаляет дочерний документ у родительского документа
URL: rest/api/docflow/doc/delete_child_document
Тип: POST
|
java.lang.String |
deleteComment(java.lang.String commentID,
java.lang.String locale)
Метод удаляет комментарий
URL: rest/api/docflow/doc/comments/remove
Тип GET
|
Response |
deleteFilter(java.lang.String filterID) |
Response |
deleteResolutionItem(java.lang.String itemID)
Метод удаляет пункт резолюции.
|
Response |
deleteResolutionProject(java.lang.String projectID)
Метод удаляет проект резолюции.
|
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? |
Response |
getContextMenuItems(java.lang.String documentID,
java.lang.String locale,
java.lang.String filterType) |
java.lang.String |
getDocCode(java.lang.String typeId) |
Response |
getDocFileInfo(java.lang.String fileID,
java.lang.String code,
java.lang.String locale) |
Response |
getDocFlowEventOptions() |
Response |
getDocType(java.lang.String code,
java.lang.String locale)
Метод API для получения описания типа документа
URL: rest/api/docflow/doctypes/{docTypeCode} Method GET |
Response |
getDocTypes(java.lang.String registerID,
java.lang.String description,
int page,
int recordsCount,
java.lang.String locale)
Метод API для получения списка типов документов
URL: rest/api/docflow/doctypes Method GET |
Response |
getDocumentChangeHistory(java.lang.String documentID,
java.lang.String locale)
Метод API получения истории изменения документа
URL: rest/api/docflow/doc/changes
Method GET Пример возвращаемого json-объекта при успешном выполнении метода: [ { "host": "", "userName": "Admin A.A |
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<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 - идентификатор действия, значение из WorkActionType operation - идентификатор операции, значение из WorkActionSubType (может отсутствовать) label - название действия color - идентификатор цвета, значение из ActionColor |
Response |
getDocumentProcesses(java.lang.String documentID,
java.lang.String locale)
Метод API получения списка ид процессов маршрута в документе, которые запустил авторизованный пользователь
URL: rest/api/docflow/doc/processes
Method GET Пример возвращаемого json-объекта при успешном выполнении метода: [ { "procInstID": "600149", "name": "13.06.2018 12.14.27" }, { "procInstID": "600153", "name": "13.06.2018 12.14.34" } ] |
java.lang.String |
getDocumentRCC(java.lang.String documentID,
java.lang.String locale)
API-метод, позволяющий получить РКК документа.
|
Response |
getDocumentsList(java.lang.String filterType,
java.lang.String filterID,
java.lang.String objectID,
java.lang.String searchString,
int pageNumber,
int countInPart,
java.lang.String locale)
Метод возвращает список документов для заданных параметров
URL: rest/api/docflow/doc/documents
Тип: GET
Ответ в виде json из списка документов.
|
java.lang.String |
getFavoriteFilters(java.lang.String locale)
Метод возвращает описание избранных фильтров
Поведение метода аналогично api методу /rest/api/doc/documents_filters - разница лишь в том, что данный метод не принимает никаких параметров (кроме локали)
Если избранных фильтров нет - сервер вернет пустой массив ("[]")
URL: rest/api/docflow/doc/favorite_doc_filters
Тип: GET
|
Response |
getFilterInfo(java.lang.String filterID,
FilterTypeEnum filterType,
java.lang.String objectID,
java.lang.String locale) |
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 ..]}
|
Response |
getListDocuments(java.lang.String filterType,
java.lang.String objectID,
java.lang.String filterID,
java.lang.String searchString,
java.lang.String fileName,
java.lang.String locale) |
java.lang.String |
getRegisterInfo(java.lang.String code,
java.lang.String registerID,
java.lang.String locale) |
Response |
getReservedList(java.lang.String registerCode,
java.lang.String registerID) |
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-метод, позволяющий получить список подписей для данного документа.
|
Response |
listDocFlowEvents() |
Response |
markDefectiveDocument(DefectDocsRequestDTO request) |
Response |
registerDocument(java.lang.String documentID) |
Response |
reject(java.lang.String documentID,
java.lang.String comment,
java.lang.String locale) |
Response |
resendDocument(java.lang.String documentID) |
Response |
save(DocumentRCC rcc) |
java.lang.String |
saveCorrespondentOrg(java.lang.String name)
Добавление корреспондента-организации в общесистемный список
Тип: POST
URL: rest/api/docflow/doc/create_correspondent_org
|
Response |
saveDefaultFilters(java.lang.String registerID) |
Response |
saveDocFlowEventOptions(DocFlowEventOptions options) |
Response |
saveDocumentAsChancellery(DocumentRCC documentRCC) |
Response |
saveFilter(DocumentFilter filter) |
Response |
saveLogRecord(LogRecord record) |
Response |
saveReservedNumber(ReserveNumberRequestDTO requestDTO) |
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 |
Response |
sendDocument(DocSendInfo sendInfo)
Метод API для пересылки документов
URL: rest/api/docflow/doc/send
Method POST Метод принимает следующие входные параметры (json): documentID - uuid документа, который необходимо переслать (обяз.); users - массив uuid пользователей, которым необходимо переслать документ; groups - массив uuid групп пользователей, которым необходимо переслать документ; emails - массив произвольных e-mail, которым необходимо переслать документ; locale - локаль. |
Response |
sendOnRegistration(java.lang.String documentID,
java.lang.String locale) |
Response |
setChildDocuments(java.lang.String documentID,
java.util.List<java.lang.String> childrenIDArray) |
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
|
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 |
Response |
stopRoute(java.lang.String documentID,
java.lang.String procInstID,
java.lang.String locale)
Метод API для прерывания маршрута документа.
|
Response |
transferDocumentAttachments(FileTransferOperation operation)
Метод API для трансфера файлов вложений из одного документа в другой
URL: rest/api/docflow/doc/attachment/transfer
Method POST |
public Response create(DocumentRCC rcc)
public Response save(DocumentRCC rcc)
public Response saveDocumentAsChancellery(DocumentRCC documentRCC)
public Response sendOnRegistration(java.lang.String documentID, java.lang.String locale)
public Response reject(java.lang.String documentID, java.lang.String comment, java.lang.String locale)
public Response saveLogRecord(LogRecord record)
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", "completionFormCode": "comment", "dict_id": "bebebebe-fefe-cece-dede-1234567890ab", "item_name": "Работа" } ] } ]
public Response getFilterInfo(java.lang.String filterID, FilterTypeEnum filterType, java.lang.String objectID, java.lang.String locale)
public Response deleteFilter(java.lang.String filterID)
public Response saveFilter(DocumentFilter filter)
public java.lang.String getRegisterInfo(java.lang.String code, java.lang.String registerID, java.lang.String locale)
public Response saveDefaultFilters(java.lang.String registerID)
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", "completionFormCode": "comment", "itemID": "52230dc9-e0ca-4a8a-846b-4ea3b9a46150", "dict_id": "fefefefe-cafe-babe-face-1234567890ab" } ]
public Response deleteResolutionItem(java.lang.String itemID)
itemID
- id пункта резолюции
public Response deleteResolutionProject(java.lang.String projectID)
projectID
- id проекта резолюции
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 Response getDocumentsList(java.lang.String filterType, java.lang.String filterID, java.lang.String objectID, java.lang.String searchString, int pageNumber, int countInPart, 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":["35d757cf-5c91-4939-9b72-7bc4af84ebf4","305fa7a9-6497-4cdf-a14a-6fb344199538","41755a49-9d37-4beb-8814-03d69dce55c9"] } ]Описание параметров: 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 - находится ли документ в процессе actions - массив, состоящий из идентификаторов работ по данному документу. В массиве возвращаются работы, которые находятся на исполнении пользователя, вызвавшего API метод. 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
filterType
- тип фильтраfilterID
- id фильтраobjectID
- objectID фильтраsearchString
- строка поискаpageNumber
- номер страницы пагинации результатовcountInPart
- количество результатов на странице пагинацииlocale
- локальpublic java.lang.String getChildDocumentsList(java.lang.String documentID, java.lang.String locale)
documentID
- documentID (uuid родительского документа, для которого получаются дочерние,
имеет смысл передавать только в том случае, если параметр hasChildren у родителя = true)locale
- локальpublic Response setChildDocuments(java.lang.String documentID, java.util.List<java.lang.String> childrenIDArray)
public Response deleteChildDocument(java.lang.String parent_documentID, java.lang.String child_documentID)
parent_documentID
- documentID родительского документа, у которого удаляется дочернийchild_documentID
- documentID дочернего документа, который подлежит удалению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", "wasOpened": "true", "actions" : ["fb051b77-6ds3-4c3f-833a8-b551a73fc1fs"], "bases" : ["3c051b77-5ds3-4ce3-84a8-b551a73fc1d9"] "rawdata" : "Z5IhLZaw8Ne8WCr0JkGlNn4hXdI=" } ]Описание параметров: 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 - бракованный ли документ wasOpened - был ли документ просмотрен actions - если пользователь по данному документу имеет несколько работ - uuid'ы этих работ будут находиться в массиве actions. bases - основания документа registryID - идентификатор реестра, в котором находится документ (может отсутствовать, если документ не принадлежит никакому реестру) registryName - имя реестра, в котором находится документ (может отсутствовать, если документ не принадлежит никакому реестру) formName - имя формы formID - идентификатор формы formCode - код формы asfDataID - идентификатор данных по форме реестра документа (может отсутствовать, если документ не принадлежит никакому реестру) rawdata - Base64 подписываемых данных документа processing - статус записи реестра (true - находится в процессе) activate - статус записи реестра (true - запись активирована)
documentID
- documentIDlocale
- локаль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
- локаль пользователя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
- - локаль пользователя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 Тип: POSTdocumentID
- UUID документаpath
- строка показывающая, в какой контейнер необходимо положить файл. (ase:attachmentContainer, ase:workContainer)fileName
- название загружаемого файлаfilePath
- путь к временному файлу, загруженному на серверlocale
- локаль пользователя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
- локаль пользователя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
- локаль пользователя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
- локаль пользователя
На данный момент поддерживается только один тип simple - к телу комментария добавляются названия объектов.public java.lang.String deleteComment(java.lang.String commentID, java.lang.String locale)
commentID
- uuid комментарияlocale
- локаль пользователяpublic java.lang.String getDocumentItems(java.lang.String documentID, java.lang.String locale)
documentID
- uuid работыlocale
- локаль пользователя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
- локаль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
- локальpublic java.lang.String getRoutes(java.lang.String search, boolean bookmarks, java.lang.String locale)
search
- строка поиска (поиск производится только по наименованию маршрутов)bookmarks
- true - отображать только скрытые, false - отображать все (по умолчанию)locale
- локаль[ { "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.util.List<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/rccdocumentID
- UUID документа (обяз.);locale
- локаль;(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/findDocByNumbernumber
- номер (обяз.);В случае неуспешного выполнения возвращается json с полями:
public java.lang.String getSignList(java.lang.String documentID, java.lang.String locale)
API-метод, позволяющий получить список подписей для данного документа.
URL rest/api/docflow/doc/sign_listdocumentID
- UUID документа (обяз.)locale
- локальВ случае неуспешного выполнения возвращается json с полями:
Пример возвращаемого массива:
[ { "userID": "Unknown", "userName": "Unknown U.", "userPosition": "Канцелярия", "date": "2023-07-05 10:54:28", "comment": "", "actionType": "SIGN_ITEM", "signType": "ECS", "action": "Подпись", "actionResult": "Подписано", "nameOgrInfo": "акционерное общество \"Казахстанский центр индустрии и экспорта \"QazIndustry\"", "bin": "100640016414", "iin": "941220350774", "keyReleaseDate": "15.03.2023", "keyExpiryDate": "14.03.2024", "email": "k.serikov@arta.pro" }, { "userID": "78w96q2e-6d55-4ed5-b1be-890ffad280ba", "userName": "Захаров М.П.", "userPosition": "Заместитель директора", "date": "2015-05-20 10:11:12", "comment": "OK", "actionType": "AGREEMENT_ITEM" "signType": "ECS" } ]
public 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/signlocale
- локаль пользователяdocumentID
- UUID документа (обяз.)rawdata
- данные для подписи base64 (обяз.)signdata
- Base64 закодированная строка с подписью (обяз., если включена настройка "Требовать ключ и сертификат")certificate
- сертификат base64 (обяз. если включена настройка требовать ключ и сертификат)certID
- идентификатор сертификата, получаемый в методе verificationkey (certID::::sigalg) (обяз., если включена настройка "Требовать ключ и сертификат");public Response transferDocumentAttachments(FileTransferOperation operation)
Метод API для трансфера файлов вложений из одного документа в другой
URL: rest/api/docflow/doc/attachment/transferoperation
- - Метод принимает следующие параметры (json):
{ "toDocId" : "359e0450-5248-11e6-81e4-5a14ad700067", "path": "ase:workContainer", "fromDocId" : "96491790-4e33-11e6-a28a-5a14ad700067", "fileCollision" : "version", "files": [ { "fileUUID" : "0db3a170-4e38-11e6-8030-001ef892a4ee"}, { "fileUUID" : "f30f6b31-4cbe-11e6-8030-001ef892a4ee"}, { "fileUUID" : "831b5d10-4da5-11e6-812b-5a14ad700067", "fileName" : "test.pdf", "filePath" : "ase:workContainer" }, { "fileName" : "test.htd", "filePath" : "ase:workContainer`" }, { "fileName" : "file1.pdf"} ] }
{ "errorCode": 0, "errorMessage": "Файлы добавлены" }
public Response getDocTypes(java.lang.String registerID, java.lang.String description, int page, int recordsCount, java.lang.String locale)
Метод API для получения списка типов документов
URL: rest/api/docflow/doctypes
Method GET
registerID
- идентификатор журнала (необяз.). При вводе данного параметра возвращаются те типы документов, которые относятся к данному журналуdescription
- параметр (необяз., по умолчанию short), который принимает следующие значения:
page
- номер страницы результатов, начиная с которой будут возвращены записи (по умолчанию 0)recordsCount
- количество результатов, которые необходимо вернуть (по умолчанию 30). Максимальное значение параметра 100locale
- локаль[ { "typeID" : "f30f6b31-4cbe-12e31f70-8030-0012a4ee", "code" : "internal", "name" : "Внутренние документы", "calc_method_term" : "WORKING_DAYS", "duration" : 5, "input_method_term" : "DURATION", "registerID" : "8f85e270-ebf1-11e5-835c-525400bb7fc6", "baseRegisterID" : "aa55e270-ebf1-11e5-835c-525400bb7fc6", "formID" : "52sf2270-4cc0-11e6-8030-001ef892a4ee", "form_type" : 0, "routes" : [ "Шаблон приказов", "Шаблон заявлений" ], "checkDocCard" : false, "demand_resuser" : false, "demand_docfile" : false, "demand_regcomment" : false, "reg_condition" : [ "demand_signature", "demand_approval" ], "fields" : [ { "name" : "subject", "number" : 1 }, { "name" : "doc_type", "number" : 2 }, { "name" : "number", "number" : 3 }, { "name" : "reg_date", "number" : 4 }, { "name" : "correspondent_org", "number" : 5 }, { "name" : "correspondent", "number" : 6 }, { "name" : "author", "number" : 7 }, { "name" : "reg_user", "number" : 9 }, { "name" : "control", "number" : 10 }, { "name" : "doc_file", "number" : 13 }, { "name" : "base", "number" : 14 } ] }, { "typeID" : "0db3a170-4e38-11e6-8030-001ef892a4ee", "code" : "incoming", "name" : "Входящие документы", "calc_method_term" : "WORKING_DAYS", "duration" : 5, "input_method_term" : "DURATION", "registerID" : "8f85e270-ebf1-11e5-835c-525400bb7fc6", "baseRegisterID" : "aa55e270-ebf1-11e5-835c-525400bb7fc6", "formID" : "22s12270-4cc0-11e6-8030-001ef892a4ee", "form_type" : 0, "routes" : [ "Шаблон входящих писем", "Шаблон писем" ], "checkDocCard" : false, "demand_resuser" : false, "demand_docfile" : false, "demand_regcomment" : false, "reg_condition" : [ "demand_signature", "demand_approval" ], "fields" : [ { "name" : "subject", "number" : 1 }, { "name" : "doc_type", "number" : 2 }, { "name" : "number", "number" : 3 }, { "name" : "reg_date", "number" : 4 }, { "name" : "correspondent_org", "number" : 5 }, { "name" : "correspondent", "number" : 6 }, { "name" : "author", "number" : 7 }, { "name" : "reg_user", "number" : 9 }, { "name" : "control", "number" : 10 }, { "name" : "doc_file", "number" : 13 }, { "name" : "base", "number" : 14 } ] }, { "typeID" : "fd96dff0-4e37-11e6-8030-001ef892a4ee", "code" : "outgoing", "name" : "Исходящие документы", "calc_method_term" : "WORKING_DAYS", "duration" : 5, "input_method_term" : "DURATION", "registerID" : "8f85e270-ebf1-11e5-835c-525400bb7fc6", "baseRegisterID" : "aa55e270-ebf1-11e5-835c-525400bb7fc6", "formID" : "21df270-4cc0-11e6-8030-001ef892a4ee", "form_type" : 0, "routes" : [ "Шаблон заявок", "Шаблон заявок на закуп" ], "checkDocCard" : false, "demand_resuser" : false, "demand_docfile" : false, "demand_regcomment" : false, "reg_condition" : [ "demand_signature", "demand_approval" ], "fields" : [ { "name" : "subject", "number" : 1 }, { "name" : "doc_type", "number" : 2 }, { "name" : "number", "number" : 3 }, { "name" : "reg_date", "number" : 4 }, { "name" : "correspondent_org", "number" : 5 }, { "name" : "correspondent", "number" : 6 }, { "name" : "author", "number" : 7 }, { "name" : "reg_user", "number" : 9 }, { "name" : "control", "number" : 10 }, { "name" : "doc_file", "number" : 13 }, { "name" : "base", "number" : 14 } ] } ]
public Response getDocType(java.lang.String code, java.lang.String locale)
Метод API для получения описания типа документа
URL: rest/api/docflow/doctypes/{docTypeCode}
Method GET
code
- код типа документа (обяз.);locale
- локаль{ "typeID" : "fd96dff0-4e37-11e6-8030-001ef892a4ee", "code" : "outgoing", "name" : "Исходящие документы", "calc_method_term" : "WORKING_DAYS", "duration" : 5, "input_method_term" : "DURATION", "registerID" : "8f85e270-ebf1-11e5-835c-525400bb7fc6", "baseRegisterID" : "aa55e270-ebf1-11e5-835c-525400bb7fc6", "formID" : "66df2270-4cc0-11e6-8030-001ef892a4ee", "form_type" : 0, "routes" : [ "Шаблон заявок", "Шаблон заявок на закуп" ], "checkDocCard" : false, "demand_resuser" : false, "demand_docfile" : false, "demand_regcomment" : false, "reg_condition" : [ "demand_signature", "demand_approval" ], "fields" : [ { "name" : "subject", "number" : 1 }, { "name" : "doc_type", "number" : 2 }, { "name" : "number", "number" : 3 }, { "name" : "reg_date", "number" : 4 }, { "name" : "correspondent_org", "number" : 5 }, { "name" : "correspondent", "number" : 6 }, { "name" : "author", "number" : 7 }, { "name" : "reg_user", "number" : 9 }, { "name" : "control", "number" : 10 }, { "name" : "doc_file", "number" : 13 }, { "name" : "base", "number" : 14 } ] }
public Response sendDocument(DocSendInfo sendInfo)
Метод API для пересылки документов
URL: rest/api/docflow/doc/send
Method POST
Метод принимает следующие входные параметры (json):
documentID - uuid документа, который необходимо переслать (обяз.);
users - массив uuid пользователей, которым необходимо переслать документ;
groups - массив uuid групп пользователей, которым необходимо переслать документ;
emails - массив произвольных e-mail, которым необходимо переслать документ;
locale - локаль.
Пример передаваемого запроса:
{
"documentID": "7ce1feff-a3f0-4f4e-8bf6-59e37caf553f",
"users": ["7b953be8-bddb-4ce4-bbfd-ae9548f69c7f", "e65f62fa-7045-4b5b-b61d-46ca00ea7af1"],
"groups": [1, 5],
"emails": ["bobrov@arta.kz"]
}
sendInfo
- json-объект;{ "errorCode": 0, "errorMessage": "Документ отправлен" }
public Response getDocumentProcesses(java.lang.String documentID, java.lang.String locale)
Метод API получения списка ид процессов маршрута в документе, которые запустил авторизованный пользователь
URL: rest/api/docflow/doc/processes
Method GET
Пример возвращаемого json-объекта при успешном выполнении метода:
[ { "procInstID": "600149", "name": "13.06.2018 12.14.27" }, { "procInstID": "600153", "name": "13.06.2018 12.14.34" } ]
documentID
- ид документаlocale
- локальpublic Response stopRoute(java.lang.String documentID, java.lang.String procInstID, java.lang.String locale)