概述
业务介绍
飞书People 流程是飞书 People 系统的流程管理平台,提供业务表单设计、流程搭建、流程管理等能力,帮助企业提升业务运转效率,支持异动、离职、请假、出差等企业内部审批流程
流程的开放接口提供了一系列安全、可靠的 API 接口和事件,来方便企业对流程信息进行查询和操作,通过 API 你可以实现以下功能:
- 流程相关信息查询:包括流程实例信息、审批任务信息、流程中的单据数据等信息查询
- 流程动态监控:可通过事件监听流程实例、流程节点、审批任务等状态变更动态
- 对流程进行操作:包括通过/拒绝审批任务等
接入流程
| 编号 | 步骤 | 介绍 |
|---|---|---|
| 1 | 创建一个应用 | 如需创建企业自建应用,可参考企业自建应用开发流程,如需创建应用商店应用,可参考 开发商店应用。 |
| 2 | 调用API,对流程进行操作 | 调用API前,你需要先获取访问凭证并开启对应的权限,详情参见 如何调用服务端API。 |
| 3 | 监听事件,获知流程的变化 | 监听事件前,你需要先申请相应的权限,详情参见 审批事件监听开发指南。 |
资源介绍
资源的定义如下:
| 资源 | 资源定义 |
|---|---|
| 流程实例 | 用户在业务功能或者飞书人事的审批中心发起的具体流程,process_id 是其唯一标识。 |
| 审批任务 | 审批任务依赖于流程节点存在,每一个流程节点可能包含一个或多个审批任务,每一个任务表明当前流程节点的审批人是谁 |
以下将详细介绍每个资源的字段、方法、事件。
资源:流程实例
查看资源 字段及示例
方法列表
| 方法 (API) | 权限要求 | 访问凭证 |
|---|---|---|
撤回流程PUT/open-apis/corehr/v2/process_withdraw/:process_id | corehr:process.instance:write | tenant_access_token |
撤销流程PUT/open-apis/corehr/v2/process_revoke/:process_id | corehr:process.instance:write | tenant_access_token |
查询流程实例列表GET/open-apis/corehr/v2/processes | corehr:process:read | tenant_access_token |
获取单个流程详情GET/open-apis/corehr/v2/processes/:process_id | corehr:process:read | tenant_access_token |
获取流程表单数据GET/open-apis/corehr/v2/processes/:process_id/form_variable_data | corehr:process:read | tenant_access_token |
事件列表
| 事件(event) | 权限要求 | 触发时机 |
|---|---|---|
| 流程实例状态变化 | corehr:process:read | 流程实例状态变化时会触发该事件 |
| 流程实例信息变更 | corehr:process:read | 流程中有审批人操作、流程数据更新、流程状态变化时会触发该事件 |
| 流程节点状态变更 | corehr:process:read | 流程中节点状态变化时会触发该事件 |
资源:审批任务
查看资源 字段及示例
方法列表
| 方法 (API) | 权限要求 | 访问凭证 |
|---|---|---|
通过/拒绝审批任务PUT/open-apis/corehr/v2/processes/:process_id/approvers/:approver_id | corehr:process.instance:write | tenant_access_token |
加签审批任务PUT/open-apis/corehr/v2/processes/:process_id/extra | corehr:process.instance:write | tenant_access_token |
转交审批任务PUT/open-apis/corehr/v2/processes/:process_id/transfer | corehr:process.instance:write | tenant_access_token |
获取指定人员审批任务列表GET/open-apis/corehr/v2/approvers | corehr:process:read | tenant_access_token |
事件列表
| 事件(event) | 权限要求 | 触发时机 |
|---|---|---|
| 审批任务状态变更 | corehr:process:read | 单个审批任务状态变化时会触发该事件 |
| 抄送单据状态变更 | corehr:process:read | 生成抄送单据后会触发该事件 |
