DQ Human Task REST API Documentation

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

Version: 1.0

/v1/{project}/human-tasks

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
assignType	query	Тип ответственного: role или usergroup или department	No	string
assignName	query	Наименование ответственного	No	[ string ]
assignId	query	ID ответственного	No	[ long ]
useCustomStateEndDateOrder	query	Использовать привилегированный порядок по статусу и сроку окончания задачи	No	boolean
withoutAssignee	query	Задачи без исполнителя	No	boolean
withDepartment	query	Задачи с департаментом	No	boolean
departmentId	query	ID подразделения	No	[ long ]

Responses

Code	Description	Schema
200	OK	[ THumanTask ]

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
assignType	query	Тип ответственного: role или usergroup или department	No	string
assignName	query	Наименование ответственного	No	[ string ]
assignId	query	ID ответственного	No	[ long ]
withoutAssignee	query	Задачи без исполнителя	No	boolean
withDepartment	query	Задачи с департаментом	No	boolean

Responses

Code	Description	Schema
200	OK	THumanTaskCount

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

PUT

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
taskMassReassign	body	Данные для переназначения пользовательских задач	Yes	THumanTaskMassReassign

Responses

Code	Description
200	OK

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID пользовательской задачи	Yes	long

Responses

Code	Description	Schema
200	OK	THumanTask

PUT

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID пользовательской задачи	Yes	long
task	body	Данные для изменения пользовательских задач	Yes	THumanTaskForPUT

Responses

Code	Description	Schema
201	OK	THumanTask

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

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID пользовательской задачи	Yes	long
body	body	Тело запроса	Yes	THumanTaskCommentRead

Responses

Code	Description
200	OK

/v1/{project}/human-task

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
task	body	Данные новой пользовательской задачи	Yes	THumanTaskForPOST

Responses

Code	Description	Schema
201	OK	THumanTask

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID пользовательской задачи	Yes	long

Responses

Code	Description	Schema
200	OK	[ THumanTaskProtocol ]

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string

Responses

Code	Description	Schema
200	OK	[ THumanTaskTemplate ]

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

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
template	body	Данные новой шаблона пользовательской задачи	Yes	THumanTaskTemplateForCreate

Responses

Code	Description	Schema
201	OK	THumanTaskTemplate

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID шаблона пользовательской задачи	Yes	long

Responses

Code	Description	Schema
200	OK	THumanTaskTemplate

PUT

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID шаблона пользовательской задачи	Yes	long
task	body	Данные для изменения шаблона пользовательской задачи	Yes	THumanTaskTemplateForUpdate

Responses

Code	Description	Schema
200	OK	THumanTaskTemplate

DELETE

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID шаблона пользовательской задачи	Yes	long

Responses

Code	Description
200	OK

/v1/{project}/task-filter

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
filter	body	Данные нового фильтра	Yes	THumanTaskFilterForPOST

Responses

Code	Description	Schema
201	OK	THumanTaskFilter

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string

Responses

Code	Description	Schema
200	OK	[ THumanTaskFilter ]

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

DELETE

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID	Yes	long

Responses

Code	Description
200	ОК

/v1/assigment-rules

GET

Summary

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

Responses

Code	Description	Schema
200	OK	[ TAssigmentRuleForGet ]

/v1/assigment-rules/{name}

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
name	path	Системное наименование алгоритма	Yes	string
task	body	Данные по задаче	Yes	HumanTaskEntity

Responses

Code	Description	Schema
200	OK	TAlgorithmResponse

/v1/assigment-rule/{id}

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
id	path	ID алгоритма	Yes	long

Responses

Code	Description	Schema
200	OK	TAssigmentRuleForGet

PUT

Summary

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

Parameters

Name	Located in	Description	Required	Schema
id	path	ID алгоритма	Yes	long
algorithm	body	Данные для изменения недистрибутивного алгоритма по распределению пользовательских задач	Yes	TAssigmentRuleForPut

Responses

Code	Description	Schema
200	OK	TAssigmentRuleForGet

DELETE

Summary

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

Parameters

Name	Located in	Description	Required	Schema
id	path	ID алгоритма	Yes	long

Responses

Code	Description
200	OK

/v1/assigment-rule

POST

Summary

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

Parameters

Name	Located in	Description	Required	Schema
algorithm	body	Данные для изменения алгоритма по изменению распределения пользовательских задач	Yes	TAssigmentRuleForPost

Responses

Code	Description	Schema
200	OK	TAssigmentRuleForGet

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string

Responses

Code	Description	Schema
200	OK	[ TResponsible ]

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

GET

Summary

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

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string

Responses

Code	Description	Schema
200	OK	[ TResponsible ]

Models

THumanTaskForPOST

Name	Type	Description	Required
template	string	Краткое наименование шаблона задачи	Yes
priority	integer		No
objectId	string	ID объекта, с которым связана задача	No
objectNumber	string	Номер объекта, с которым связана задача	No
startDate	dateTime	Дата начала выполнения задачи . по умолчанию, текущая	No
externalId	string (uuid)	ID пользовательской задачи во внешней системе ,например, Camunda	No
processInstanceId	string	ID бизнес процесса, в котором была создана задача	No
correlationId	string (uuid)	ID корреляции для бизнес процесса	No
details	object	Детальная информация по задаче	No
description	string	Описание задачи	No
comment	string	Комментарий к задаче	No
departmentId	long	ID основного подразделения	No
departmentIds	[ long ]	Идентификаторы подразделений	No
serviceName	string	Имя сервиса	No
activityName	string	Наименование узла пользовательской задачи	No
activityId	string	ID узла пользовательской задачи	No
activityInstanceId	string	ID экземпляра узла пользовательской задачи	No
processDefinitionId	string	ID бизнес-процесса	No
processDefinitionKey	string	Системное наименование бизес-процесса	No
processDefinitionName	string	Наименование бизнес-процесса	No
processDefinitionVersion	integer	Версия бизнес-процесса	No
subject	string	Субъект	No
priority2	integer	Приоритет 2	No
priority3	integer	Приоритет 3	No
duration	long	Время обработки задачи в миллисекундах	No
parentId	long	ID родительской задачи	No
type	string	Тип задачи (DELEGATE, ESCALATION)	No
assigneeId	long	ID исполнителя	No
assignee	string	Исполнитель	No
initiatorId	long	Инициатор задачи	No
initiatorName	string	Наименование инициатора задачи	No
assigneePosition	string	Должность пользователя	No

THumanTask

Name	Type	Description	Required
id	long	ID пользовательской задачи	Yes
templateSysName	string	Системное наименование шаблона задачи	Yes
templateName	string	Полное наименование шаблона задачи	No
priority	integer		No
taskForm	string		No
confirm	boolean	Флаг подверждения выполняемого действия	No
takeNext	boolean	Флаг возможности взятия доступных, следующих задач	No
objectType	string	Краткое наименование типа объекта	Yes
objectId	string	ID объекта, с которым связана задача	Yes
objectNumber	string	Номер объекта, с которым связана задача	No
startDate	dateTime	Дата начала выполнения задачи . по умолчанию, текущая	No
createDate	dateTime	Дата создания задачи	Yes
closeDate	dateTime	дата завершения/отмены задачи , в случае если задача в конечном состоянии	No
endDate	dateTime	плановая дата выполнения задачи ,определяется в случае если в шаблоне указан таймер для выполнения задачи	No
assignDate	dateTime	дата последнего назначения ответственного	No
processDate	dateTime	плановая дата завершения обработки задачи , определяется в случае если в шаблоне указан таймер для обработки задачи	No
assigneeId	long	ID исполнителя	No
assignee	string	Исполнитель	No
expired	boolean	признак просрочки задачи , по умолчанию false	No
processResult	string	результат выполнения задачи	No
processResultName	string	наименование результата выполнения задачи	No
comment	string	комментарий к результату выполнения задачи	No
cancelReason	string	описание причины отмены задачи	No
state	string	Системное наименование состояния задачи	Yes
stateName	string	Наименование состояния задачи	No
externalId	string (uuid)	ID пользовательской задачи во внешней системе ,например, Camunda	No
processInstanceId	string	ID бизнес процесса, в котором была создана задача	No
correlationId	string (uuid)	ID корреляции для бизнес процесса	No
details	object	Детальная информация по задаче	No
description	string	Описание задачи	No
departmentId	long	ID основного подразделения	No
departmentIds	[ long ]	Идентификаторы подразделений	No
assignType	string	Тип группы назначения: role, usergroup, department	No
assignName	string	Наименование группы, на которую будет назначена задача	No
serviceName	string	Имя сервиса	No
activityName	string	Наименование узла пользовательской задачи	No
activityId	string	ID узла пользовательской задачи	No
processDefinitionId	string	ID бизнес-процесса	No
processDefinitionKey	string	Системное наименование бизес-процесса	No
processDefinitionName	string	Наименование бизнес-процесса	No
processDefinitionVersion	integer	Версия бизнес-процесса	No
colorCategory	string	Цвет категории задачи	No
isCommentRead	boolean	Факт прочтения коментарий по задаче	No
dateProtocolProcessing	dateTime	Дата последнего состояния протокола	No
subject	string	Субъект	No
priority2	integer	Приоритет 2	No
priority3	integer	Приоритет 3	No
duration	long	Время обработки задачи в миллисекундах	No
parentId	long	ID родительской задачи	No
type	string	Тип задачи (DELEGATE, ESCALATION)	No
initiatorId	long	Инициатор задачи	No
initiatorName	string	Наименование инициатора задачи	No
assigneePosition	string	Должность пользователя	No
childTypes	[ string ]		No
actionList	[ TActionItem ]	Действия для обработки пользовательской задачи	No

THumanTaskCount

Name	Type	Description	Required
count	long	Количество задач	Yes

THumanTaskMassReassign

Name	Type	Description	Required
taskList	[ long ]	Список идентификаторов задач	Yes
assigneeId	long	ID исполнителя	Yes
assignee	string	Испольнитель	No

THumanTaskProtocol

Name	Type	Description	Required
id	long	ID записи протокола	Yes
taskId	long	ID пользовательской задачи	Yes
date	dateTime	Дата создания записи	Yes
state	string	Системное наименование состояния задачи, в которое она переходит	Yes
stateName	string	Наименование состояния задачи, в которое она переходит	Yes
assigneeId	long	ID исполнителя	No
assignee	string	Исполнитель	No
expired	boolean	Признак просрочки задачи , по умолчанию : false	No
userId	long	ID пользователя, инициировавшего создание/изменение задачи	Yes
duration	long	Время нахождения задачи в статусе	No
details	string	Детали	No

THumanTaskForPUT

Name	Type	Description	Required
startDate	dateTime	Дата начала выполнения задачи . по умолчанию, текущая	No
assigneeId	long	ID исполнителя	No
assignee	string	Исполнитель	No
colorCategory	string	Цвет категории	No
priority	integer	Приоритет	No
priority2	integer	Приоритет 2	No
priority3	integer	Приоритет 3	No
subject	string	Субъект	No
endDate	dateTime	Плановая дата выполнения задачи	No
initiatorId	long	Инициатор задачи	No
initiatorName	string	Наименование инициатора задачи	No
assigneePosition	string	Должность пользователя	No
departmentId	long	ID основного подразделения	No
departmentIds	[ long ]	Идентификаторы подразделений	No

THumanTaskTemplate

Name	Type	Description	Required
id	long	ID шаблона задачи	No
sysName	string	Системное наименование шаблона	No
name	string	Наименование шаблона	No
state	string	Состояние шаблона	No
stateName	string	Наименование состояния шаблона	No
version	integer	Версия шаблона	No
taskForm	string	Ссылка на форму обработки задачи	No
maxExecutionTime	integer	Плановое время исполнения задачи (в минутах)	No
createDate	dateTime	Дата создания шаблона	No
endDate	dateTime	Период действия	No
algorithmId	long	ID алгоритма	No
confirm	boolean	Признак подверждения выполняемого действия	No
actions	object (json)	Действия для обработки пользовательской задачи	No
actionList	[ TActionItem ]	Действия для обработки пользовательской задачи	No
escalationTemplateId	long	ID шаблона эскалации	No
escalationCriterion	string	Критерий эскалации (PROCESSING_DURATION, EXPIRATION)	No
escalationValue	integer	Время под критерий эскалации, в минутах	No
excludeTaskInitiator	boolean	Запретить инициатору обработать задачу	No
responsibles	[ TResponsibleItem ]	Список ответственных	No
takeNext	boolean	Признак взятия в обработку следующие задачи	No

TActionItem

Name	Type	Description	Required
label	string	Наименование действия	Yes
key	string	Системное наименование действия	Yes
position	integer	Порядок	No

THumanTaskTemplateForCreate

Name	Type	Description	Required
sysName	string	Системное наименование шаблона	Yes
name	string	Наименование шаблона	Yes
version	integer	Версия шаблона	No
maxExecutionTime	integer	Регламентное время обработки задачи (в минутах)	No
taskForm	string	Ссылка на форму обработки задачи	No
algorithmId	long	ID алгоритма	No
confirm	boolean	Признак подверждения выполняемого действия	No
state	string	Статус шаблона	Yes
createDate	dateTime	Дата создания шаблона	Yes
endDate	dateTime	Дата деактивации шаблона	No
actions	object (json)	Действия для обработки пользовательской задачи	No
actionList	[ TActionItem ]	Действия для обработки пользовательской задачи	No
escalationTemplateId	long	ID шаблона эскалации	No
escalationCriterion	string	Критерий эскалации (PROCESSING_DURATION, EXPIRATION)	No
escalationValue	integer	Время под критерий эскалации, в минутах	No
excludeTaskInitiator	boolean	Запретить инициатору обработать задачу	No
responsibles	[ TResponsibleItem ]	Список ответственных	Yes
takeNext	boolean	Признак взятия в обработку следующие задачи	No

TResponsibleItem

Name	Type	Description	Required
subjectType	string	Тип ответственного	Yes
subjectId	long	ID ответственного	No
subject	string	Ответственный	Yes
subjectName	string	Наименование ответственного	Yes

THumanTaskTemplateForUpdate

Name	Type	Description	Required
sysName	string	Системное наименование шаблона	No
name	string	Наименование шаблона	No
version	integer	Версия шаблона	No
maxExecutionTime	integer	Регламентное время обработки задачи (в минутах)	No
taskForm	string	Ссылка на форму обработки задачи	No
algorithmId	long	ID алгоритма	No
confirm	boolean	Признак подверждения выполняемого действия	No
state	string	Статус шаблона	No
endDate	dateTime	Дата деактивации шаблона	No
actions	object (json)	Действия для обработки пользовательской задачи	No
actionList	[ TActionItem ]	Действия для обработки пользовательской задачи	No
escalationTemplateId	long	ID шаблона эскалации	No
escalationCriterion	string	Критерий эскалации (PROCESSING_DURATION, EXPIRATION)	No
escalationValue	integer	Время под критерий эскалации, в минутах	No
excludeTaskInitiator	boolean	Запретить инициатору обработать задачу	No
responsibles	[ TResponsibleItem ]	Список ответственных	No
takeNext	boolean	Признак взятия в обработку следующие задачи	No

THumanTaskFilterForPOST

Name	Type	Description	Required
userId	long	ID пользователя	No
userName	string	Пользователь	No
name	string	Наименование шаблона	Yes
details	string	json фильтр	Yes

THumanTaskFilter

Name	Type	Description	Required
id	long	ID фильтра	No
userId	long	ID пользователя	No
userName	string	Пользователь	No
name	string	Наименование шаблона	No
details	string	json фильтр	No

THumanTaskCommentRead

Name	Type	Description	Required
userId	long	ID пользователя	Yes
userName	string	Пользователь	No

TResponsible

Name	Type	Description	Required
subject	string	Ответственный	No
subjectId	long	ID ответственного	No
subjectName	string	Наименование ответственного	No

TAssigmentRuleForGet

Name	Type	Description	Required
id	long	ID алгоритма	No
name	string	Наименование алгоритма	No
endpoint	string	Ссылка на метод для формирования запроса на получение идентификатора исполнителя	No
serviceName	string	Имя сервиса	No
isDistribution	boolean	Флаг дистрибутивного алгоритма	No
createdDate	dateTime	Дата - время создания	No

TAssigmentRuleForPost

Name	Type	Description	Required
name	string	Наименование алгоритма	Yes
endpoint	string	Ссылка на метод для формирования запроса на получение идентификатора исполнителя	Yes
serviceName	string	Имя сервиса	Yes
isDistribution	boolean	Флаг дистрибутивного алгоритма	Yes

TAssigmentRuleForPut

Name	Type	Description	Required
name	string	Наименование алгоритма	No
endpoint	string	Ссылка на метод для формирования запроса на получение идентификатора исполнителя	No
serviceName	string	Имя сервиса	No

TAlgorithmResponse

Name	Type	Description	Required
assigneeId	long	ID ответственного по задаче	No
departmentId	long	ID подразделения	No
departmentIds	[ long ]	Идентификаторы подразделений	No
description	string	Описание к задаче	No

HumanTaskEntity

Name	Type	Description	Required
HumanTaskEntity	object

HumanTaskProtocolEntity

Name	Type	Description	Required
HumanTaskProtocolEntity	object

HumanTaskTemplateEntity

Name	Type	Description	Required
HumanTaskTemplateEntity	object

HumanTaskFilterEntity

Name	Type	Description	Required
HumanTaskFilterEntity	object

HumanTaskAlgorithmEntity

Name	Type	Description	Required
HumanTaskAlgorithmEntity	object

HumanTaskNotificationResponsibleEntity

Name	Type	Description	Required
HumanTaskNotificationResponsibleEntity	object

Переходы пользовательских заданий Мониторинг процессов