查询任务列表 - queryTaskList
功能介绍
查询任务列表。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /services/workflow/queryTaskList/{pageSize}/{curPage}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pageSize | 是 | String | 参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| curPage | 是 | String | 参数解释: 当前页。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: IAM用户的token。 通过调用IAM服务获取用户Token接口获取(即响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| X-Application-Id | 是 | String | 参数解释: 应用ID。 您可以在应用设计态的“应用中心 > 应用发布”页面获取,详情请参见应用发布。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 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 | 参数解释: 流程创建开始时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processInstanceEndTime | 否 | String | 参数解释: 流程创建结束时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createStartTime | 否 | String | 参数解释: 任务启动开始时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createEndTime | 否 | String | 参数解释: 任务启动结束时间。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionId | 否 | String | 参数解释: 流程模板ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| businessKeys | 否 | String | 参数解释: 业务流水号。如需添加多个业务流水号,请用英文逗号(,)隔开。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionName | 否 | String | 参数解释: 流程定义英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionNameCn | 否 | String | 参数解释: 流程模板中文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionNames | 否 | String | 参数解释: 流程模板名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskDefinitionKey | 否 | String | 参数解释: 任务定义编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskDefinitionName | 否 | String | 参数解释: 任务定义名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| pageSize | 否 | Integer | 参数解释: 每页的条数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| curPage | 否 | Integer | 参数解释: 当前页数。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| businessKey | 否 | String | 参数解释: 业务流水号。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| i18n | 否 | Integer | 参数解释: 国际化标识。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| title | 否 | String | 参数解释: 流程标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| titleCn | 否 | String | 参数解释: 流程的中文标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| titles | 否 | Array of strings | 参数解释: 流程标题列表。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createdBy | 否 | String | 参数解释: 创建人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| category | 否 | String | 参数解释: 流程类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateName | 否 | String | 参数解释: 最后修改人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskHandler | 否 | String | 参数解释: 任务处理人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| requestSource | 否 | String | 参数解释: 请求源。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| startUserId | 否 | String | 参数解释: 发起流程的用户。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sites | 否 | String | 参数解释: 站点。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| userId | 否 | String | 参数解释: 用户ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| orderId | String | 参数解释: 请求跟踪流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
| msg | String | 参数解释: 接口响应信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| code | Integer | 参数解释: 接口返回码。 取值范围: 不涉及。 默认取值: 不涉及。 |
| data | Array of HistoricProcessInstanceVO objects | 参数解释: 接口响应数据。 取值范围: 不涉及。 默认取值: 不涉及。 |
| pageInfo | PageVo object | 参数解释: 标准响应体分页信息。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| processInstanceId | String | 参数解释: 流程实例ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionId | String | 参数解释: 流程定义ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionName | String | 参数解释: 流程定义英文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processDefinitionNameCn | String | 参数解释: 流程定义中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| businessKey | String | 参数解释: 业务流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskDefinitionKey | String | 参数解释: 任务节点流水号。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskDefinitionName | String | 参数解释: 任务节点名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| startTime | String | 参数解释: 开始时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| title | String | 参数解释: 流程标题。 取值范围: 不涉及。 默认取值: 不涉及。 |
| state | String | 参数解释: 流程实例运行状态。 取值范围: 默认取值: 不涉及。 |
| lifeCycleState | String | 参数解释: 生命周期状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
| handlers | String | 参数解释: 处理人。 取值范围: 不涉及。 默认取值: 不涉及。 |
| userIds | String | 参数解释: 用户ID集合。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateDate | String | 参数解释: 最后更新时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| suspensionState | String | 参数解释: 流程暂停状态。 取值范围: 默认取值: 不涉及。 |
| processInstanceStartTime | String | 参数解释: 流程实例开始时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| processInstanceEndTime | String | 参数解释: 流程实例结束时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createdBy | String | 参数解释: 创建人ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createdByName | String | 参数解释: 创建人账号。 取值范围: 不涉及。 默认取值: 不涉及。 |
| endTime | String | 参数解释: 结束时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| tenantId | String | 参数解释: 租户ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| userId | String | 参数解释: 用户ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createStartTime | String | 参数解释: 创建开始时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createEndTime | String | 参数解释: 创建结束时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| createTaskTime | String | 参数解释: 任务创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| completeStartTime | String | 参数解释: 审批结束的开始时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| category | String | 参数解释: 流程类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
| completeEndTime | String | 参数解释: 审批结束的结束时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
| transferSign | String | 参数解释: 代办标志。 取值范围: 默认取值: 不涉及。 |
| taskId | String | 参数解释: 任务ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| startUserId | String | 参数解释: 启动用户ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| startUserName | String | 参数解释: 启动用户名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| taskUrl | String | 参数解释: 任务的URL。 取值范围: 不涉及。 默认取值: 不涉及。 |
| groupIds | String | 参数解释: 群组ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lookUpId | String | 参数解释: LookUp ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
| filterResult | Array of strings | 参数解释: 定制返回结果。 取值范围: 不涉及。 默认取值: 不涉及。 |
| groupIdList | Array of strings | 参数解释: 群组ID集合。 取值范围: 不涉及。 默认取值: 不涉及。 |
| sequenceCount | Integer | 参数解释: 序列数。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateBy | String | 参数解释: 最后更新人。 取值范围: 不涉及。 默认取值: 不涉及。 |
| lastUpdateName | String | 参数解释: 最后更新人名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
| operationState | String | 参数解释: 流程操作状态。 取值范围: 默认取值: 不涉及。 |
| site | String | 参数解释: 引擎站点标识。 取值范围: 不涉及。 默认取值: 不涉及。 |
| dueDate | String | 参数解释: 截止日期。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求示例
入参包含userId则查对应user的任务,不包含则查当前登录用户的任务
https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/queryTaskList/2/1
{
"userId" : "1008600000065234815"
} 响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
错误码
请参见错误码。