文档首页> 产品数字化协同平台云服务> API参考> IPDCenter Space服务API> 流程定义API> 查询流程列表
更新时间：2024-05-27 GMT+08:00
查看PDF
分享

查询流程列表

功能介绍

查询流程列表。

URI

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

示例接口地址：{域名（有文根需带文根）}/pdmcore/ipdcworkflowservice/services/workflow/queryProcessesList/2/1

表1 路径参数

参数

是否必选

参数类型

描述

pageSize

是

String

分页大小

curPage

是

String

当前页数

请求头

使用机机认证调用接口时需传入header：Authorization，其值为机机鉴权token。

请求参数

表2 请求body参数，筛选条件

参数

是否必选

参数类型

描述

pageSize

否

Integer

每页的条数

curPage

否

Integer

当前页数

processSearchType

否

String

查询类型

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

流程实例状态

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

国际化标识

lifeCycleState

否

String

生命周期状态

lifeCycleStates

否

Array of strings

生命周期状态集合

sites

否

Array of strings

引擎站点标识

unionQuery

否

String

查询标识

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

orderId

String

请求跟踪流水号

msg

String

接口响应信息

code

Integer

接口返回码

data

Array of ProcessInstanceVO objects

接口响应数据,JSON对象或数组

pageInfo

PageVo object

标准响应体分页信息
表4 ProcessInstanceVO

参数

参数类型

描述

processInstanceId

String

流程实例ID

processDefinitionName

String

流程定义名称

processDefinitionNameCn

String

流程定义中文名称

businessKey

String

业务流水号

title

String

流程标题

category

String

流程类型

createdByName

String

创建人账号

processInstanceStartTime

String

流程实例开始时间

processInstanceEndTime

String

流程实例结束时间

state

String

流程实例状态："挂起：SUSPENDED；未完成：ACTIVE;已完成：COMPLETED；取消：INTERNALLY_TERMINATED

lifeCycleState

String

生命周期状态

taskList

Array of Task objects

任务信息列表

site

String

引擎站点标识
表5 Task

参数

参数类型

描述

processInstanceId

String

流程实例ID

taskId

String

任务ID

taskDefinitionKey

String

节点key

taskDefinitionName

String

任务节点名称

handlers

String

任务处理人短工号集合，有多个时使用","号分割

userIds

String

任务处理人ID集合，有多个时使用","号分割

groupIds

String

群组ID集合，有多个时使用","号分割

ccuserIds

String

抄送用户ID集合，有多个时使用","号分割

ccUserNames

String

抄送用户账号集合，有多个时使用","号分割

startTime

String

任务开始时间

endTime

String

任务结束时间

status

String

任务状态：suspended、finished、doing

createdBy

String

创建人ID

createName

String

任务创建人

approvalUserName

String

审批人用户名
表6 PageVo

参数

参数类型

描述

totalRows

Integer

总共有多少条数据

curPage

Integer

当前是第几页

pageSize

Integer

一页有多少条数据

totalPages

Integer

总共有多少页

请求示例

无

响应示例

状态码： 200

带分页的标准响应体

{ 
  "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

带分页的标准响应体

错误码

请参见错误码。

父主题： 流程定义API
分享：

    相关文档

    相关产品