public class SettingsService
extends java.lang.Object
| Constructor and Description |
|---|
SettingsService() |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getProcesses(java.lang.String locale)
Метод возвращает список основных процессов, которые используется в системе
URL: rest/api/settings/get_processes Тип GET |
Response |
getProcessSettings(java.lang.String typeID,
java.lang.String locale)
Метод возвращает описания настроек процессов
URL: rest/api/settings/get_process_settings Тип GET |
java.util.LinkedHashMap |
getProcessSettingsWrapper(ProcessMessages pm,
java.lang.String processType,
java.lang.String locale) |
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 - отображать ли поле "автор" при создании работы date_resolution_after_finish_document - разрешено ли ставить работы по резолюции, завершающиеся после документа 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 |
getWorkDays(java.lang.String date_start,
java.lang.String date_finish,
java.lang.String type)
Метод возвращает периоды рабочего времени с типами для каждого дня в запрашиваемом интервале
URL: rest/api/settings/calendar Тип GET |
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_PROJECTpublic 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 java.lang.String getUserID()
public Response getProcessSettings(java.lang.String typeID,
java.lang.String locale)
typeID - - тип процесса.(обяз) Допустимые варианты описаны ниже.locale - - локаль пользователя, ru/en/kz (не обяз., по умолчанию ru).
Список допустимых вариантов для передаваемого параметра typeID:
ASSIGNMENT_ITEM - работа
AGREEMENT_ITEM - согласование
APPROVAL_ITEM - утверждение
ACQUAINTANCE_ITEM - ознакомление
RESOLUTION_ACTION - резолюция
SEND_DOCUMENT - отправка документа
BLOCKING_PROCESS - блокирующий процесс
REGISTRATION_ITEM - регистрация
ROUTE_ITEM - маршрут Пример запроса:
`rest/api/settings/get_process_settings?typeID=ASSIGNMENT_ITEM`
Пример ответа на запрос для ASSIGNMENT_ITEM :
{"data":{
"type":"assignment",
"number":1,
"name":"Работа2",
"ph":{
"phInProgress":"",
"phNegativeAnswer":"",
"phPositiveAnswer":"",
"phInterrupted":"",
"phFuture":""
},
"wl":{
"wlNegativeAnswer":"",
"wlWaiting":"",
"wlPositiveAnswer":""
},
"wr":{
"wrAcceptButton":"",
"wrFinishButton":""
},
"pf":{
"pfNegativeAnswer":"",
"pfPositiveAnswer":"",
"pfTitle":""
},
"rcSubstitution":"",
"apTitle":"В работу",
"apCompleteButton":"Завершить",
"wcSubstitution":"",
"wcSendButton":"Перепоручить",
"n":{
"nNegativeAnswer":"",
"nWorkPercentChanged":"Пользователь {0} изменил процент выполнения работы \"{1}\" - {2}%
Для просмотра документа данной работы перейдите по ссылке.",
"nFinishWork":"Пользователь {0} отметил работу \"{1}\" как {2}
Для просмотра документа данной работы перейдите по ссылке.",
"nPositiveAnswer":"",
"nPositiveAnswerWithComment":"",
"nCreateDocument":"Пользователь {0}поручил вам работу по документу \"{1}\",
срок: {2}
Для просмотра документа данной работы перейдите по ссылке.",
"nNegativeAnswerWithComment":"",
"nCreateWork":"Пользователь {0} создал для Вас новую работу \"{1}\",
срок: {2}
Для просмотра документа данной работы перейдите по ссылке."
}
}
}
public java.util.LinkedHashMap getProcessSettingsWrapper(ProcessMessages pm,
java.lang.String processType,
java.lang.String locale)