文档首页/ 工业数字模型驱动引擎/ API参考/ API/ 流程引擎/ 流程监控/ 查询流程实例列表
更新时间：2024-11-27 GMT+08:00
查看PDF
分享

查询流程实例列表

功能介绍

查询流程实例列表。

URI

POST /services/workflow/queryProcessesInstanceList/{pageSize}/{curPage}

表1 路径参数

参数

是否必选

参数类型

描述

pageSize

是

String

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

curPage

是

String

参数解释：

当前页。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

IAM用户的token。

通过调用IAM服务获取用户Token接口获取（即响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Application-Id

是

String

参数解释：

应用ID。

您可以在应用设计态的“应用中心 > 应用发布”页面获取，详情请参见应用发布。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Tenant-Id

是

String

参数解释：

当前IAM的租户ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

pageSize

否

Integer

参数解释：

每页的条数。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

curPage

否

Integer

参数解释：

当前页。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processSearchType

否

String

参数解释：

查询类型。

约束限制：

不涉及。

取值范围：

  • CREATED_BY：创建人。

  • APPROVED_BY：审批人。

默认取值：

不涉及。

approvalUserName

否

String

参数解释：

审批人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processInstanceId

否

String

参数解释：

流程实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processInstanceIds

否

Array of strings

参数解释：

流程实例ID集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

category

否

String

参数解释：

流程分类。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

title

否

String

参数解释：

流程名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

titleCn

否

String

参数解释：

流程中文标题。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

titles

否

Array of strings

参数解释：

流程标题列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processDefinitionName

否

String

参数解释：

流程定义英文名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processDefinitionNameCn

否

String

参数解释：

流程类型的中文名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

processDefinitionNames

否

Array of strings

参数解释：

流程类型名称集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

businessKey

否

String

参数解释：

流程编码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

businessKeys

否

Array of strings

参数解释：

流程编码集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

createdByName

否

String

参数解释：

流程的创建人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

creatBy

否

String

参数解释：

流程的创建人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

state

否

String

参数解释：

流程实例状态。

约束限制：

不涉及。

取值范围：

  • SUSPENDED ：挂起。

  • ACTIVE：未完成。

  • COMPLETED：已完成。

  • INTERNALLY_TERMINATED：取消。

默认取值：

不涉及。

states

否

Array of strings

参数解释：

流程状态集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

startTimeStart

否

String

参数解释：

流程实例创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

startTimeEnd

否

String

参数解释：

流程实例创建时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

endTimeStart

否

String

参数解释：

流程实例结束时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

endTimeEnd

否

String

参数解释：

流程实例结束时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

taskStatus

否

String

参数解释：

任务状态。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

taskDefinitionKey

否

String

参数解释：

任务节点Key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

taskDefinitionKeys

否

Array of strings

参数解释：

任务节点Key集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

taskDefinitionName

否

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

taskDefinitionNames

否

Array of strings

参数解释：

任务名称集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

handlers

否

Array of strings

参数解释：

处理人集合。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ccUserNames

否

Array of strings

参数解释：

当前任务抄送人。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

includeColumn

否

String

参数解释：

需要展示任务列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

i18n

否

Integer

参数解释：

国际化标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sites

否

Array of strings

参数解释：

引擎站点标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

unionQuery

否

String

参数解释：

查询标识。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

orderId

String

参数解释：

请求跟踪流水号。

取值范围：

不涉及。

默认取值：

不涉及。

msg

String

参数解释：

接口响应信息。

取值范围：

不涉及。

默认取值：

不涉及。

code

Integer

参数解释：

接口返回码。

取值范围：

不涉及。

默认取值：

不涉及。

data

Array of HistoricProcessInstanceVO objects

参数解释：

接口响应数据。

取值范围：

不涉及。

默认取值：

不涉及。

pageInfo

PageVo object

参数解释：

标准响应体分页信息。

取值范围：

不涉及。

默认取值：

不涉及。
表5 HistoricProcessInstanceVO

参数

参数类型

描述

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

参数解释：

代办标志。

取值范围：

  • 0：我的待办。

  • 1：可转审的。

默认取值：

不涉及。

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

参数解释：

截止日期。

取值范围：

不涉及。

默认取值：

不涉及。
表6 PageVo

参数

参数类型

描述

totalRows

Integer

参数解释：

数据总数。

取值范围：

不涉及。

默认取值：

不涉及。

curPage

Integer

参数解释：

当前页。

取值范围：

不涉及。

默认取值：

不涉及。

pageSize

Integer

参数解释：

页大小。

取值范围：

不涉及。

默认取值：

不涉及。

totalPages

Integer

参数解释：

总页数。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

https://dme.cn-north-4.huaweicloud.cn/workflowRuntime/services/workflow/queryProcessesInstanceList/20/1

响应示例

状态码： 200

OK

{
  "msg" : null,
  "code" : 0,
  "data" : [ {
    "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603",
    "processDefinitionName" : "WXR2024031201",
    "processDefinitionNameCn" : "WXR2024031201",
    "businessKey" : "P10000538",
    "title" : "WXR2024031201_2024-03-12T20:21:13.868+0800",
    "category" : "http://bpmn.io/schema/bpmn",
    "createdByName" : "hid_ryk8erneykog7xq",
    "processInstanceStartTime" : 1710246074028,
    "processInstanceEndTime" : null,
    "state" : "ACTIVE",
    "lifeCycleState" : null,
    "taskList" : [ {
      "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603",
      "taskId" : "1104e5be-e06b-11ee-a306-fa163e3e9603",
      "taskDefinitionKey" : "Activity_1voprlj",
      "taskDefinitionName" : "用户任务",
      "handlers" : "u.hid_ryk8erneykog7xq",
      "userIds" : "1008600000046291663",
      "groupIds" : "",
      "ccuserIds" : "",
      "ccUserNames" : null,
      "startTime" : 1710246094672,
      "endTime" : null,
      "status" : "doing",
      "createdBy" : "1008600000046291663",
      "createName" : null,
      "approvalUserName" : null
    }, {
      "processInstanceId" : "04b6df66-e06b-11ee-a306-fa163e3e9603",
      "taskId" : "04b7f0e2-e06b-11ee-a306-fa163e3e9603",
      "taskDefinitionKey" : "Activity_0g0ayay",
      "taskDefinitionName" : "用户任务",
      "handlers" : "u.hid_ryk8erneykog7xq",
      "userIds" : "1008600000046291663",
      "groupIds" : "",
      "ccuserIds" : "",
      "ccUserNames" : null,
      "startTime" : 1710246074035,
      "endTime" : 1710246094662,
      "status" : "finished",
      "createdBy" : "1008600000046291663",
      "createName" : null,
      "approvalUserName" : "hid_ryk8erneykog7xq"
    } ],
    "site" : null
  } ],
  "pageInfo" : {
    "totalRows" : 1,
    "curPage" : 1,
    "pageSize" : 1,
    "totalPages" : 1
  },
  "orderID" : "83b252e6e6384be7b8374a46307781b8"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 流程监控

相关文档