Process Monitoring API
Process Monitoring

DQ Human Task REST API Documentation

Microservices DQ Human Task - Сервис исполнения пользовательских задач

Version: 1.0


/v1/{project}/human-tasks

GET

Summary

Получение списка пользовательских задач по параметрам

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
assignTypequeryТип ответственного: role или usergroup или departmentNostring
assignNamequeryНаименование ответственногоNo[ string ]
assignIdqueryID ответственногоNo[ long ]
useCustomStateEndDateOrderqueryИспользовать привилегированный порядок по статусу и сроку окончания задачиNoboolean
withoutAssigneequeryЗадачи без исполнителяNoboolean
withDepartmentqueryЗадачи с департаментомNoboolean
departmentIdqueryID подразделенияNo[ long ]
Responses
CodeDescriptionSchema
200OK[ THumanTask ]

/v1/{project}/human-tasks/count

GET

Summary

Получение количества задач по параметрам

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
assignTypequeryТип ответственного: role или usergroup или departmentNostring
assignNamequeryНаименование ответственногоNo[ string ]
assignIdqueryID ответственногоNo[ long ]
withoutAssigneequeryЗадачи без исполнителяNoboolean
withDepartmentqueryЗадачи с департаментомNoboolean
Responses
CodeDescriptionSchema
200OKTHumanTaskCount

/v1/{project}/human-task/reassign

PUT

Summary

Массовое переназначение пользовательских задач

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
taskMassReassignbodyДанные для переназначения пользовательских задачYesTHumanTaskMassReassign
Responses
CodeDescription
200OK

/v1/{project}/human-task/{id}

GET

Summary

Получение данных пользовательской задачи по ID задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID пользовательской задачиYeslong
Responses
CodeDescriptionSchema
200OKTHumanTask

PUT

Summary

Изменение пользовательской задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID пользовательской задачиYeslong
taskbodyДанные для изменения пользовательских задачYesTHumanTaskForPUT
Responses
CodeDescriptionSchema
201OKTHumanTask

/v1/{project}/human-task/{id}/comment-read

POST

Summary

Cохранения состояния прочитанного комментария

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID пользовательской задачиYeslong
bodybodyТело запросаYesTHumanTaskCommentRead
Responses
CodeDescription
200OK

/v1/{project}/human-task

POST

Summary

Создание пользовательских задач

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
taskbodyДанные новой пользовательской задачиYesTHumanTaskForPOST
Responses
CodeDescriptionSchema
201OKTHumanTask

/v1/{project}/human-task/{id}/protocol

GET

Summary

Получение протокола пользовательской задачи по ID задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID пользовательской задачиYeslong
Responses
CodeDescriptionSchema
200OK[ THumanTaskProtocol ]

/v1/{project}/human-task-templates

GET

Summary

Получение списка шаблонов пользовательских задач по параметрам

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
Responses
CodeDescriptionSchema
200OK[ THumanTaskTemplate ]

/v1/{project}/human-task-template

POST

Summary

Создание шаблона пользовательской задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
templatebodyДанные новой шаблона пользовательской задачиYesTHumanTaskTemplateForCreate
Responses
CodeDescriptionSchema
201OKTHumanTaskTemplate

/v1/{project}/human-task-template/{id}

GET

Summary

Получение описания шаблона задачи по идентификатору

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID шаблона пользовательской задачиYeslong
Responses
CodeDescriptionSchema
200OKTHumanTaskTemplate

PUT

Summary

Изменение шаблона пользовательской задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID шаблона пользовательской задачиYeslong
taskbodyДанные для изменения шаблона пользовательской задачиYesTHumanTaskTemplateForUpdate
Responses
CodeDescriptionSchema
200OKTHumanTaskTemplate

DELETE

Summary

Удаление шаблона пользовательской задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathID шаблона пользовательской задачиYeslong
Responses
CodeDescription
200OK

/v1/{project}/task-filter

POST

Summary

Создания шаблонного фильтра

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
filterbodyДанные нового фильтраYesTHumanTaskFilterForPOST
Responses
CodeDescriptionSchema
201OKTHumanTaskFilter

GET

Summary

Получение списка шаблонных фильтров

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
Responses
CodeDescriptionSchema
200OK[ THumanTaskFilter ]

/v1/{project}/task-filter/{id}

DELETE

Summary

Удаление шаблонного фильтра

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
idpathIDYeslong
Responses
CodeDescription
200ОК

/v1/assigment-rules

GET

Summary

Получение списка алгоритмов по распределению пользовательских задач

Responses
CodeDescriptionSchema
200OK[ TAssigmentRuleForGet ]

/v1/assigment-rules/{name}

POST

Summary

Запуск алгоритма по системному наименованию

Parameters
NameLocated inDescriptionRequiredSchema
namepathСистемное наименование алгоритмаYesstring
taskbodyДанные по задачеYesHumanTaskEntity
Responses
CodeDescriptionSchema
200OKTAlgorithmResponse

/v1/assigment-rule/{id}

GET

Summary

Получение алгоритма по распределению пользовательских задач по id

Parameters
NameLocated inDescriptionRequiredSchema
idpathID алгоритмаYeslong
Responses
CodeDescriptionSchema
200OKTAssigmentRuleForGet

PUT

Summary

Изменение недистрибутивного алгоритма по распределению пользовательских задач по id

Parameters
NameLocated inDescriptionRequiredSchema
idpathID алгоритмаYeslong
algorithmbodyДанные для изменения недистрибутивного алгоритма по распределению пользовательских задачYesTAssigmentRuleForPut
Responses
CodeDescriptionSchema
200OKTAssigmentRuleForGet

DELETE

Summary

Удаление недистрибутивного алгоритма по распределению пользовательских задач по id

Parameters
NameLocated inDescriptionRequiredSchema
idpathID алгоритмаYeslong
Responses
CodeDescription
200OK

/v1/assigment-rule

POST

Summary

Добавление алгоритма по распределению пользовательских задач

Parameters
NameLocated inDescriptionRequiredSchema
algorithmbodyДанные для изменения алгоритма по изменению распределения пользовательских задачYesTAssigmentRuleForPost
Responses
CodeDescriptionSchema
200OKTAssigmentRuleForGet

/v1/{project}/human-tasks/responsible-users

GET

Summary

Получение списка пользователей назначеных на задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
Responses
CodeDescriptionSchema
200OK[ TResponsible ]

/v1/{project}/human-tasks/responsible-roles

GET

Summary

Получение списка ролей назначеных на задачи

Parameters
NameLocated inDescriptionRequiredSchema
projectpathСистемное наименование проектаYesstring
Responses
CodeDescriptionSchema
200OK[ TResponsible ]

Models

THumanTaskForPOST

NameTypeDescriptionRequired
templatestringКраткое наименование шаблона задачиYes
priorityintegerNo
objectIdstringID объекта, с которым связана задачаNo
objectNumberstringНомер объекта, с которым связана задачаNo
startDatedateTimeДата начала выполнения задачи . по умолчанию, текущаяNo
externalIdstring (uuid)ID пользовательской задачи во внешней системе ,например, CamundaNo
processInstanceIdstringID бизнес процесса, в котором была создана задачаNo
correlationIdstring (uuid)ID корреляции для бизнес процессаNo
detailsobjectДетальная информация по задачеNo
descriptionstringОписание задачиNo
commentstringКомментарий к задачеNo
departmentIdlongID основного подразделенияNo
departmentIds[ long ]Идентификаторы подразделенийNo
serviceNamestringИмя сервисаNo
activityNamestringНаименование узла пользовательской задачиNo
activityIdstringID узла пользовательской задачиNo
activityInstanceIdstringID экземпляра узла пользовательской задачиNo
processDefinitionIdstringID бизнес-процессаNo
processDefinitionKeystringСистемное наименование бизес-процессаNo
processDefinitionNamestringНаименование бизнес-процессаNo
processDefinitionVersionintegerВерсия бизнес-процессаNo
subjectstringСубъектNo
priority2integerПриоритет 2No
priority3integerПриоритет 3No
durationlongВремя обработки задачи в миллисекундахNo
parentIdlongID родительской задачиNo
typestringТип задачи (DELEGATE, ESCALATION)No
assigneeIdlongID исполнителяNo
assigneestringИсполнительNo
initiatorIdlongИнициатор задачиNo
initiatorNamestringНаименование инициатора задачиNo
assigneePositionstringДолжность пользователяNo

THumanTask

NameTypeDescriptionRequired
idlongID пользовательской задачиYes
templateSysNamestringСистемное наименование шаблона задачиYes
templateNamestringПолное наименование шаблона задачиNo
priorityintegerNo
taskFormstringNo
confirmbooleanФлаг подверждения выполняемого действияNo
takeNextbooleanФлаг возможности взятия доступных, следующих задачNo
objectTypestringКраткое наименование типа объектаYes
objectIdstringID объекта, с которым связана задачаYes
objectNumberstringНомер объекта, с которым связана задачаNo
startDatedateTimeДата начала выполнения задачи . по умолчанию, текущаяNo
createDatedateTimeДата создания задачиYes
closeDatedateTimeдата завершения/отмены задачи , в случае если задача в конечном состоянииNo
endDatedateTimeплановая дата выполнения задачи ,определяется в случае если в шаблоне указан таймер для выполнения задачиNo
assignDatedateTimeдата последнего назначения ответственногоNo
processDatedateTimeплановая дата завершения обработки задачи , определяется в случае если в шаблоне указан таймер для обработки задачиNo
assigneeIdlongID исполнителяNo
assigneestringИсполнительNo
expiredbooleanпризнак просрочки задачи , по умолчанию falseNo
processResultstringрезультат выполнения задачиNo
processResultNamestringнаименование результата выполнения задачиNo
commentstringкомментарий к результату выполнения задачиNo
cancelReasonstringописание причины отмены задачиNo
statestringСистемное наименование состояния задачиYes
stateNamestringНаименование состояния задачиNo
externalIdstring (uuid)ID пользовательской задачи во внешней системе ,например, CamundaNo
processInstanceIdstringID бизнес процесса, в котором была создана задачаNo
correlationIdstring (uuid)ID корреляции для бизнес процессаNo
detailsobjectДетальная информация по задачеNo
descriptionstringОписание задачиNo
departmentIdlongID основного подразделенияNo
departmentIds[ long ]Идентификаторы подразделенийNo
assignTypestringТип группы назначения: role, usergroup, departmentNo
assignNamestringНаименование группы, на которую будет назначена задачаNo
serviceNamestringИмя сервисаNo
activityNamestringНаименование узла пользовательской задачиNo
activityIdstringID узла пользовательской задачиNo
processDefinitionIdstringID бизнес-процессаNo
processDefinitionKeystringСистемное наименование бизес-процессаNo
processDefinitionNamestringНаименование бизнес-процессаNo
processDefinitionVersionintegerВерсия бизнес-процессаNo
colorCategorystringЦвет категории задачиNo
isCommentReadbooleanФакт прочтения коментарий по задачеNo
dateProtocolProcessingdateTimeДата последнего состояния протоколаNo
subjectstringСубъектNo
priority2integerПриоритет 2No
priority3integerПриоритет 3No
durationlongВремя обработки задачи в миллисекундахNo
parentIdlongID родительской задачиNo
typestringТип задачи (DELEGATE, ESCALATION)No
initiatorIdlongИнициатор задачиNo
initiatorNamestringНаименование инициатора задачиNo
assigneePositionstringДолжность пользователяNo
childTypes[ string ]No
actionList[ TActionItem ]Действия для обработки пользовательской задачиNo

THumanTaskCount

NameTypeDescriptionRequired
countlongКоличество задачYes

THumanTaskMassReassign

NameTypeDescriptionRequired
taskList[ long ]Список идентификаторов задачYes
assigneeIdlongID исполнителяYes
assigneestringИспольнительNo

THumanTaskProtocol

NameTypeDescriptionRequired
idlongID записи протоколаYes
taskIdlongID пользовательской задачиYes
datedateTimeДата создания записиYes
statestringСистемное наименование состояния задачи, в которое она переходитYes
stateNamestringНаименование состояния задачи, в которое она переходитYes
assigneeIdlongID исполнителяNo
assigneestringИсполнительNo
expiredbooleanПризнак просрочки задачи , по умолчанию : falseNo
userIdlongID пользователя, инициировавшего создание/изменение задачиYes
durationlongВремя нахождения задачи в статусеNo
detailsstringДеталиNo

THumanTaskForPUT

NameTypeDescriptionRequired
startDatedateTimeДата начала выполнения задачи . по умолчанию, текущаяNo
assigneeIdlongID исполнителяNo
assigneestringИсполнительNo
colorCategorystringЦвет категорииNo
priorityintegerПриоритетNo
priority2integerПриоритет 2No
priority3integerПриоритет 3No
subjectstringСубъектNo
endDatedateTimeПлановая дата выполнения задачиNo
initiatorIdlongИнициатор задачиNo
initiatorNamestringНаименование инициатора задачиNo
assigneePositionstringДолжность пользователяNo
departmentIdlongID основного подразделенияNo
departmentIds[ long ]Идентификаторы подразделенийNo

THumanTaskTemplate

NameTypeDescriptionRequired
idlongID шаблона задачиNo
sysNamestringСистемное наименование шаблонаNo
namestringНаименование шаблонаNo
statestringСостояние шаблонаNo
stateNamestringНаименование состояния шаблонаNo
versionintegerВерсия шаблонаNo
taskFormstringСсылка на форму обработки задачиNo
maxExecutionTimeintegerПлановое время исполнения задачи (в минутах)No
createDatedateTimeДата создания шаблонаNo
endDatedateTimeПериод действияNo
algorithmIdlongID алгоритмаNo
confirmbooleanПризнак подверждения выполняемого действияNo
actionsobject (json)Действия для обработки пользовательской задачиNo
actionList[ TActionItem ]Действия для обработки пользовательской задачиNo
escalationTemplateIdlongID шаблона эскалацииNo
escalationCriterionstringКритерий эскалации (PROCESSING_DURATION, EXPIRATION)No
escalationValueintegerВремя под критерий эскалации, в минутахNo
excludeTaskInitiatorbooleanЗапретить инициатору обработать задачуNo
responsibles[ TResponsibleItem ]Список ответственныхNo
takeNextbooleanПризнак взятия в обработку следующие задачиNo

TActionItem

NameTypeDescriptionRequired
labelstringНаименование действияYes
keystringСистемное наименование действияYes
positionintegerПорядокNo

THumanTaskTemplateForCreate

NameTypeDescriptionRequired
sysNamestringСистемное наименование шаблонаYes
namestringНаименование шаблонаYes
versionintegerВерсия шаблонаNo
maxExecutionTimeintegerРегламентное время обработки задачи (в минутах)No
taskFormstringСсылка на форму обработки задачиNo
algorithmIdlongID алгоритмаNo
confirmbooleanПризнак подверждения выполняемого действияNo
statestringСтатус шаблонаYes
createDatedateTimeДата создания шаблонаYes
endDatedateTimeДата деактивации шаблонаNo
actionsobject (json)Действия для обработки пользовательской задачиNo
actionList[ TActionItem ]Действия для обработки пользовательской задачиNo
escalationTemplateIdlongID шаблона эскалацииNo
escalationCriterionstringКритерий эскалации (PROCESSING_DURATION, EXPIRATION)No
escalationValueintegerВремя под критерий эскалации, в минутахNo
excludeTaskInitiatorbooleanЗапретить инициатору обработать задачуNo
responsibles[ TResponsibleItem ]Список ответственныхYes
takeNextbooleanПризнак взятия в обработку следующие задачиNo

TResponsibleItem

NameTypeDescriptionRequired
subjectTypestringТип ответственногоYes
subjectIdlongID ответственногоNo
subjectstringОтветственныйYes
subjectNamestringНаименование ответственногоYes

THumanTaskTemplateForUpdate

NameTypeDescriptionRequired
sysNamestringСистемное наименование шаблонаNo
namestringНаименование шаблонаNo
versionintegerВерсия шаблонаNo
maxExecutionTimeintegerРегламентное время обработки задачи (в минутах)No
taskFormstringСсылка на форму обработки задачиNo
algorithmIdlongID алгоритмаNo
confirmbooleanПризнак подверждения выполняемого действияNo
statestringСтатус шаблонаNo
endDatedateTimeДата деактивации шаблонаNo
actionsobject (json)Действия для обработки пользовательской задачиNo
actionList[ TActionItem ]Действия для обработки пользовательской задачиNo
escalationTemplateIdlongID шаблона эскалацииNo
escalationCriterionstringКритерий эскалации (PROCESSING_DURATION, EXPIRATION)No
escalationValueintegerВремя под критерий эскалации, в минутахNo
excludeTaskInitiatorbooleanЗапретить инициатору обработать задачуNo
responsibles[ TResponsibleItem ]Список ответственныхNo
takeNextbooleanПризнак взятия в обработку следующие задачиNo

THumanTaskFilterForPOST

NameTypeDescriptionRequired
userIdlongID пользователяNo
userNamestringПользовательNo
namestringНаименование шаблонаYes
detailsstringjson фильтрYes

THumanTaskFilter

NameTypeDescriptionRequired
idlongID фильтраNo
userIdlongID пользователяNo
userNamestringПользовательNo
namestringНаименование шаблонаNo
detailsstringjson фильтрNo

THumanTaskCommentRead

NameTypeDescriptionRequired
userIdlongID пользователяYes
userNamestringПользовательNo

TResponsible

NameTypeDescriptionRequired
subjectstringОтветственныйNo
subjectIdlongID ответственногоNo
subjectNamestringНаименование ответственногоNo

TAssigmentRuleForGet

NameTypeDescriptionRequired
idlongID алгоритмаNo
namestringНаименование алгоритмаNo
endpointstringСсылка на метод для формирования запроса на получение идентификатора исполнителяNo
serviceNamestringИмя сервисаNo
isDistributionbooleanФлаг дистрибутивного алгоритмаNo
createdDatedateTimeДата - время созданияNo

TAssigmentRuleForPost

NameTypeDescriptionRequired
namestringНаименование алгоритмаYes
endpointstringСсылка на метод для формирования запроса на получение идентификатора исполнителяYes
serviceNamestringИмя сервисаYes
isDistributionbooleanФлаг дистрибутивного алгоритмаYes

TAssigmentRuleForPut

NameTypeDescriptionRequired
namestringНаименование алгоритмаNo
endpointstringСсылка на метод для формирования запроса на получение идентификатора исполнителяNo
serviceNamestringИмя сервисаNo

TAlgorithmResponse

NameTypeDescriptionRequired
assigneeIdlongID ответственного по задачеNo
departmentIdlongID подразделенияNo
departmentIds[ long ]Идентификаторы подразделенийNo
descriptionstringОписание к задачеNo

HumanTaskEntity

NameTypeDescriptionRequired
HumanTaskEntityobject

HumanTaskProtocolEntity

NameTypeDescriptionRequired
HumanTaskProtocolEntityobject

HumanTaskTemplateEntity

NameTypeDescriptionRequired
HumanTaskTemplateEntityobject

HumanTaskFilterEntity

NameTypeDescriptionRequired
HumanTaskFilterEntityobject

HumanTaskAlgorithmEntity

NameTypeDescriptionRequired
HumanTaskAlgorithmEntityobject

HumanTaskNotificationResponsibleEntity

NameTypeDescriptionRequired
HumanTaskNotificationResponsibleEntityobject