Skip to content

查询流程实例列表

本接口用于查询流程实例列表,支持通过流程定义 ID 等进行查询(此功能不受数据权限范围控制),其中:

  • 流程实例:是指用户在业务功能或者飞书人事的审批中心发起的具体流程,process_id 是其唯一标识。

  • 流程定义:是指管理员在设置侧配置的流程,类似流程模板,flow_definition_id 是其唯一标识。用户发起的流程是按照对应的流程定义的配置生成。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/processes
HTTP MethodGET
接口频率限制20 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:process:read 获取流程数据

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
statusesint\[\]查询流程状态列表。如需一次查询多个状态值,可通过将同一参数名多次传递,并且每次传递不同的参数值。例如:https://{url}?statuses=1&statuses=2
可选值:
- 1:进行中
- 2:已拒绝
- 4:已撤回
- 8:已撤销
- 9:已完成
- 15:撤销中
示例值:1
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:7278949005675988535
page_sizeint分页大小,取值范围:1 ~ 100
示例值:10
数据校验规则
- 最大值:100
modify_time_fromstring流程实例修改时间的查询起始值,闭区间。
修改时间的更新时机:流程中有审批人操作、流程数据更新、流程状态变化等
单位:ms。从 1970 年 1 月 1 日 (UTC/GMT的午夜) 开始经过的毫秒数
注意:起始时间和终止时间跨度要小于 31 天
示例值:1547654251506
modify_time_tostring流程实例修改时间的查询终止值,闭区间
修改时间的更新时机:流程中有审批人操作、流程数据更新、流程状态变化等
单位:ms。从 1970 年 1 月 1 日 (UTC/GMT的午夜) 开始经过的毫秒数
注意:起始时间和终止时间跨度要小于 31 天
示例值:1547654251506
flow_definition_idstring流程定义ID
可通过获取单个流程详情查询流程实例对应的流程定义ID
示例值:people_6961286846093788680_7081951411982077732

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ process_idsstring\[\]流程实例ID列表
可通过获取单个流程详情 查询流程详情
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "process_ids": [
            "7278949005675988535"
        ],
        "has_more": true,
        "page_token": "7278949005675988535"
    }
}

错误码

HTTP状态码错误码描述排查建议
4001160101Invalid parameter参数错误,请操作接口字段说明自查
5001160500System error系统异常,请咨询技术支持协助排查。
5001160102Internal system error系统内部异常,请咨询技术支持协助排查。

内容来源:飞书开放平台 · 自动爬取整理