查询任务列表 - queryTaskList
功能介绍
本接口用于分页查询任务列表,适用于管理员批量查看应用下的任务信息,或业务系统通过多种条件组合筛选任务。
与完成任务 - completeTask接口配合,可处理待办任务;与查询复杂流程图数据 - queryActInstInfoByProcId接口配合,可展示任务在流程图中的位置和执行轨迹。
接口约束
本接口支持基础版和体验版数据建模引擎-流程引擎场景。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /services/workflow/queryTaskList/{pageSize}/{curPage}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 是 | String | 参数解释: 分页大小,指定每页返回的记录数量。需与“curPage”同时传入才生效。 约束限制: 建议取值范围1-100,过大可能影响接口性能。 取值范围: 正整数,取值范围1-100。 默认取值: 不涉及。 |
| curPage | 是 | String | 参数解释: 当前页码,用于指定分页查询的页数。需与“pageSize”同时传入才生效,从1开始计数。 约束限制: 正整数,从1开始。 取值范围: 正整数,取值范围1-1000。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Application-Id | 是 | String | 参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 由英文字母和数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| X-Tenant-Id | 是 | String | 参数解释: 数据建模引擎运行态租户ID。 您可以从访问流程引擎编排服务的浏览器地址栏中获取。 流程编排服务地址:http://{承载流程编排服务的服务器域名或IP地址}:{流程编排服务的端口号}/{流程编排服务文根}/index.html#/processApplicationForm?tenantId={数据建模引擎运行态租户ID}&applicationId={应用ID} 例如tenantId=-1,表示数据建模引擎运行态默认租户“basicTenant”的租户ID为-1。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-User-Id | 是 | String | 参数解释: 请求当前接口时上下文中的用户ID,即OrgID的用户ID。 通过调用OrgID服务的获取用户信息接口获取。 约束限制: 仅基础版数据建模引擎-流程引擎需要配置此参数。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| processInstanceStartTime | 否 | String | 参数解释: 流程创建开始时间,用于按流程实例创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 需与processInstanceEndTime配合使用。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| processInstanceEndTime | 否 | String | 参数解释: 流程创建结束时间,用于按流程实例创建时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 需与processInstanceStartTime配合使用。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| createStartTime | 否 | String | 参数解释: 任务启动开始时间,用于按任务启动时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 需与createEndTime配合使用。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| createEndTime | 否 | String | 参数解释: 任务启动结束时间,用于按任务启动时间范围筛选。建议格式为yyyy-MM-dd HH:mm:ss。 约束限制: 需与createStartTime配合使用。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| processDefinitionId | 否 | String | 参数解释: 流程模板ID,用于按流程模板定义ID筛选任务。与流程设计态中的模板Key一致。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| businessKeys | 否 | String | 参数解释: 业务流水号,用于按多个业务流水号批量筛选任务。如需添加多个业务流水号,请用英文逗号(,)隔开。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| processDefinitionName | 否 | String | 参数解释: 流程定义英文名称,用于按流程模板英文名称筛选任务。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| processDefinitionNameCn | 否 | String | 参数解释: 流程模板中文名称,用于按流程模板中文名称筛选任务。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| processDefinitionNames | 否 | String | 参数解释: 流程模板名称,用于按流程模板名称筛选任务。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| taskDefinitionKey | 否 | String | 参数解释: 任务定义编码,用于按任务节点定义Key筛选任务。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| taskDefinitionName | 否 | String | 参数解释: 任务定义名称,用于按任务节点名称筛选任务。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| pageSize | 否 | Integer | 参数解释: 每页的条数,指定每页返回的记录数量。建议与路径参数pageSize保持一致。 约束限制: 建议取值范围1-100。 取值范围: 正整数。 默认取值: 不涉及。 |
| curPage | 否 | Integer | 参数解释: 当前页数,指定查询第几页的数据。建议与路径参数curPage保持一致。 约束限制: 从1开始计数。 取值范围: 正整数。 默认取值: 不涉及。 |
| businessKey | 否 | String | 参数解释: 业务流水号,用于按单个业务流水号精确筛选任务。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| i18n | 否 | Integer | 参数解释: 国际化标识,用于指定响应数据的语言版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| title | 否 | String | 参数解释: 流程标题,用于按流程实例标题筛选任务。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| titleCn | 否 | String | 参数解释: 流程的中文标题,用于按流程中文标题筛选任务。支持模糊匹配。 约束限制: 不涉及。 取值范围: 最大长度4000字符。 默认取值: 不涉及。 |
| titles | 否 | Array of strings | 参数解释: 流程标题列表,用于按多个流程标题批量筛选任务。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createdBy | 否 | String | 参数解释: 创建人,用于按任务创建人ID筛选任务。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| category | 否 | String | 参数解释: 流程类型,用于按流程分类筛选任务。通常为BPMN标准命名空间。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| lastUpdateName | 否 | String | 参数解释: 最后修改人,用于按最后修改人账号筛选任务。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| taskHandler | 否 | String | 参数解释: 任务处理人,用于按任务处理人账号筛选任务。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| requestSource | 否 | String | 参数解释: 请求源,用于标识调用来源系统或模块。 约束限制: 不涉及。 取值范围: 最大长度100字符。 默认取值: 不涉及。 |
| startUserId | 否 | String | 参数解释: 发起流程的用户,用于按流程发起人ID筛选任务。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| sites | 否 | String | 参数解释: 站点,用于按引擎站点筛选任务。多个站点之间用英文逗号(,)隔开。 约束限制: 不涉及。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
| userId | 否 | String | 参数解释: 用户ID,用于指定查询哪个用户的任务。传入时查询指定用户的任务;不传时默认查询当前登录用户(X-User-Id)的任务。 约束限制: 需具备对应用户的任务查询权限。 取值范围: 最大长度1000字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| orderId | String | 参数解释: 请求跟踪流水号,用于唯一标识本次接口请求,便于问题排查和链路追踪。 遇到问题时,请提供此ID联系技术支持。 取值范围: 不涉及。 |
| msg | String | 参数解释: 接口响应信息,描述接口调用的结果说明。当code非200时,此字段包含具体的错误描述。 取值范围: 不涉及。 |
| code | Integer | 参数解释: 接口返回码,标识接口调用的执行结果。 取值范围:
|
| data | Array of HistoricProcessInstanceVO objects | 参数解释: 接口响应数据,包含当前页的任务列表。每个元素为一个任务的详细信息,包括所属流程实例、任务节点信息、处理人、任务状态等。 取值范围: 不涉及。 |
| pageInfo | PageVo object | 参数解释: 标准响应体分页信息,包含总记录数、当前页、页大小、总页数等。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| processInstanceId | String | 参数解释: 流程实例ID,标识该任务所属的流程实例。可通过此ID调用查询流程实例详情接口获取更多信息。 取值范围: 不涉及。 |
| processDefinitionId | String | 参数解释: 流程定义ID,标识任务所属的流程模板定义ID,包含模板Key和版本信息。 取值范围: 不涉及。 |
| processDefinitionName | String | 参数解释: 流程定义英文名称,标识任务所属流程模板的英文名称。 取值范围: 不涉及。 |
| processDefinitionNameCn | String | 参数解释: 流程定义中文名称,标识任务所属流程模板的中文名称,用于展示。 取值范围: 不涉及。 |
| businessKey | String | 参数解释: 业务流水号,即申请单Key,由业务系统生成。可通过此值调用根据businessKey查询流程信息接口获取流程基本信息。 取值范围: 不涉及。 |
| taskDefinitionKey | String | 参数解释: 任务节点流水号,标识任务在流程模板中的节点定义Key。 取值范围: 不涉及。 |
| taskDefinitionName | String | 参数解释: 任务节点名称,标识任务在流程模板中的节点名称,用于展示。 取值范围: 不涉及。 |
| startTime | String | 参数解释: 开始时间,标识任务被创建的时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| title | String | 参数解释: 流程标题,通常为流程模板名称与创建时间的组合,用于展示。 取值范围: 不涉及。 |
| state | String | 参数解释: 流程实例运行状态,标识任务所属流程实例的当前状态。 注意:此字段在响应示例中显示为任务节点名称,实际应为流程状态标识。 取值范围: |
| lifeCycleState | String | 参数解释: 生命周期状态,标识流程实例的生命周期阶段。 取值范围: 不涉及。 |
| handlers | String | 参数解释: 处理人,标识当前任务的处理人账号。多个处理人之间用英文逗号(,)隔开。 取值范围: 不涉及。 |
| userIds | String | 参数解释: 用户ID集合,标识当前任务的处理人短工号。多个处理人之间用英文逗号(,)隔开。 取值范围: 不涉及。 |
| lastUpdateDate | String | 参数解释: 最后更新时间,标识任务最近一次状态变更的时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| suspensionState | String | 参数解释: 流程暂停状态,标识任务所属流程实例是否被挂起。 取值范围: |
| processInstanceStartTime | String | 参数解释: 流程实例开始时间,标识任务所属流程实例的启动时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| processInstanceEndTime | String | 参数解释: 流程实例结束时间,标识任务所属流程实例的完成或终止时间。若流程仍在运行中,此字段为null。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| createdBy | String | 参数解释: 创建人ID,标识创建该任务的用户ID。 取值范围: 不涉及。 |
| createdByName | String | 参数解释: 创建人账号,标识创建该任务的用户登录账号。 取值范围: 不涉及。 |
| endTime | String | 参数解释: 结束时间,标识任务被完成或终止的时间。若任务仍在处理中,此字段为null。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| tenantId | String | 参数解释: 租户ID,标识任务所属的数据建模引擎租户。 取值范围: 不涉及。 |
| userId | String | 参数解释: 用户ID,标识当前登录用户的ID。 取值范围: 不涉及。 |
| createStartTime | String | 参数解释: 创建开始时间,用于记录任务创建的时间范围起点。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| createEndTime | String | 参数解释: 创建结束时间,用于记录任务创建的时间范围终点。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| createTaskTime | String | 参数解释: 任务创建时间,标识任务被创建的具体时间。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| completeStartTime | String | 参数解释: 审批结束的开始时间,用于记录任务完成的时间范围起点。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| category | String | 参数解释: 流程类型,标识任务所属流程实例的分类。通常为BPMN标准命名空间。 取值范围: 不涉及。 |
| completeEndTime | String | 参数解释: 审批结束的结束时间,用于记录任务完成的时间范围终点。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| transferSign | String | 参数解释: 代办标志,标识任务的转审状态。 取值范围: |
| taskId | String | 参数解释: 任务ID,用于唯一标识一个任务。可通过此ID调用审批任务接口完成任务处理。 取值范围: 不涉及。 |
| startUserId | String | 参数解释: 启动用户ID,标识发起该流程实例的用户ID。 取值范围: 不涉及。 |
| startUserName | String | 参数解释: 启动用户名称,标识发起该流程实例的用户账号。 取值范围: 不涉及。 |
| taskUrl | String | 参数解释: 任务的URL,标识任务详情页面的访问地址。可用于前端直接跳转至任务处理页面。 取值范围: 不涉及。 |
| groupIds | String | 参数解释: 群组ID,标识当前任务的处理群组。多个群组之间用英文逗号(,)隔开。 取值范围: 不涉及。 |
| lookUpId | String | 参数解释: LookUp ID,用于关联业务系统的Lookup配置。 取值范围: 不涉及。 |
| filterResult | Array of strings | 参数解释: 定制返回结果,用于指定需要额外返回的字段列表。 取值范围: 不涉及。 |
| groupIdList | Array of strings | 参数解释: 群组ID集合,标识当前任务关联的所有群组ID列表。 取值范围: 不涉及。 |
| sequenceCount | Integer | 参数解释: 序列数,标识任务在流程中的序号或同一流程实例下的任务数量。 取值范围: 不涉及。 |
| lastUpdateBy | String | 参数解释: 最后更新人,标识最后修改该任务状态的用户ID。 取值范围: 不涉及。 |
| lastUpdateName | String | 参数解释: 最后更新人名称,标识最后修改该任务状态的用户账号。 取值范围: 不涉及。 |
| operationState | String | 参数解释: 流程操作状态,标识任务的当前操作状态。 取值范围: |
| site | String | 参数解释: 引擎站点标识,用于多站点部署场景下的数据隔离。 取值范围: 不涉及。 |
| dueDate | String | 参数解释: 截止日期,标识任务的处理截止日期。若超过此日期未处理,任务可能标记为逾期。格式为Unix时间戳(毫秒)。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| totalRows | Integer | 参数解释: 数据总数,标识符合条件的流程实例总记录数。 取值范围: 非负整数。 |
| curPage | Integer | 参数解释: 当前页码,与请求参数中的curPage一致。 取值范围: 正整数。 |
| pageSize | Integer | 参数解释: 页大小,与请求参数中的pageSize一致。 取值范围: 正整数。 |
| totalPages | Integer | 参数解释: 总页数,根据totalRows和pageSize计算得出的总页数。计算公式为ceil(totalRows / pageSize)。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
| result | String | 结果。 |
| trace_id | String | 追踪ID。 |
请求示例
入参包含userId则查对应user的任务,不包含则查当前登录用户的任务
POST https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/queryTaskList/2/1
{
"userId" : "1008600000065234815"
} 响应示例
状态码:200
OK
{
"msg" : null,
"code" : 0,
"data" : [ {
"processInstanceId" : "4dab643a-e074-11ee-90c9-7804e3968f51",
"processDefinitionId" : "WXR2024031201:5:32ff36dd48024b9b8da61e8b44dd27df",
"processDefinitionName" : "WXR2024031201",
"processDefinitionNameCn" : "WXR2024031201",
"businessKey" : "P10000546",
"taskDefinitionKey" : "Activity_0g0ayay",
"taskDefinitionName" : "用户任务",
"startTime" : 1710250062324,
"title" : "WXR2024031201_2024-03-12T21:27:39.334+0800",
"state" : "用户任务",
"lifeCycleState" : null,
"handlers" : "u.hid_fje4j2nvnue3xwp",
"userIds" : "1008600000065234815",
"lastUpdateDate" : 1710250062324,
"suspensionState" : "1",
"processInstanceStartTime" : 1710250062559,
"processInstanceEndTime" : null,
"createdBy" : "hid_fje4j2nvnue3xwp",
"createdByName" : "hid_fje4j2nvnue3xwp",
"endTime" : null,
"tenantId" : "definition_micro",
"userId" : null,
"createStartTime" : null,
"createEndTime" : null,
"createTaskTime" : 1710250062324,
"completeStartTime" : null,
"category" : "http://bpmn.io/schema/bpmn",
"completeEndTime" : null,
"transferSign" : null,
"taskId" : "4dec8bf6-e074-11ee-90c9-7804e3968f51",
"startUserId" : "1008600000065234815",
"startUserName" : "hid_fje4j2nvnue3xwp",
"taskUrl" : null,
"groupIds" : "",
"lookUpId" : null,
"filterResult" : null,
"groupIdList" : null,
"sequenceCount" : 1,
"lastUpdateBy" : "1008600000065234815",
"lastUpdateName" : "hid_fje4j2nvnue3xwp",
"operationState" : null,
"site" : null,
"dueDate" : null
}, {
"processInstanceId" : "e16e7fcc-e073-11ee-9c6b-7804e3968f51",
"processDefinitionId" : "WXR2024031201:5:32ff36dd48024b9b8da61e8b44dd27df",
"processDefinitionName" : "WXR2024031201",
"processDefinitionNameCn" : "WXR2024031201",
"businessKey" : "P10000545",
"taskDefinitionKey" : "Activity_0g0ayay",
"taskDefinitionName" : "用户任务",
"startTime" : 1710249880386,
"title" : "WXR2024031201_2024-03-12T21:24:39.240+0800",
"state" : "用户任务",
"lifeCycleState" : null,
"handlers" : "u.hid_fje4j2nvnue3xwp",
"userIds" : "1008600000065234815",
"lastUpdateDate" : 1710249880386,
"suspensionState" : "1",
"processInstanceStartTime" : 1710249880510,
"processInstanceEndTime" : null,
"createdBy" : "hid_fje4j2nvnue3xwp",
"createdByName" : "hid_fje4j2nvnue3xwp",
"endTime" : null,
"tenantId" : "definition_micro",
"userId" : null,
"createStartTime" : null,
"createEndTime" : null,
"createTaskTime" : 1710249880386,
"completeStartTime" : null,
"category" : "http://bpmn.io/schema/bpmn",
"completeEndTime" : null,
"transferSign" : null,
"taskId" : "e17b02f8-e073-11ee-9c6b-7804e3968f51",
"startUserId" : "1008600000065234815",
"startUserName" : "hid_fje4j2nvnue3xwp",
"taskUrl" : null,
"groupIds" : "",
"lookUpId" : null,
"filterResult" : null,
"groupIdList" : null,
"sequenceCount" : 1,
"lastUpdateBy" : "1008600000065234815",
"lastUpdateName" : "hid_fje4j2nvnue3xwp",
"operationState" : null,
"site" : null,
"dueDate" : null
} ],
"pageInfo" : {
"totalRows" : 28,
"curPage" : 1,
"pageSize" : 2,
"totalPages" : 14
},
"orderID" : "043a0fd2a2e547649eed73b50e82b98e"
} 状态码:400
Bad Request
{
"error_code" : "500",
"error_msg" : "origin is not allowed!",
"result" : "FAIL",
"trace_id" : "2509bee60b3e40asdf9f741d9e23466a9"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
错误码
请参见错误码。