Skip to content

撤回流程

对状态为“审批中”的单个审批实例进行撤回操作,撤回后审批流程结束

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/process_withdraw/:process_id
HTTP MethodPUT
接口频率限制50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:process.instance:write 通过/拒绝审批任务
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
process_idstring流程实例ID。可通过查询流程实例列表接口获取
示例值:"7328345170959681068"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID? - people_corehr_id: people corehr系统的用户id
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
user_idstring按照查询参数中指定的用户ID类型传递对应的用户ID,默认为Open ID。如果system_user为true,此字段可不填
示例值:"ou_91791271921729102012"
reasonstring原因
示例值:"原因自定义字符串"
数据校验规则
- 最大长度:500 字符
system_userboolean是否以系统身份操作,如果为false,则user_id必填
示例值:true
默认值false

请求体示例

json
{
    "user_id": "ou_91791271921729102012",
    "reason": "原因自定义字符串",
    "system_user": true
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码错误码描述排查建议
4001160101参数错误参数错误,请操作接口字段说明自查
4031161003无权限指定用户非流程发起人、流程管理员以及审批单管理员或未申请OpenAPI撤回流程权限
4001161005审批状态已更新审批状态已更新,请稍后重试
4001161006所有审批已经结束请检查当前流程状态是否为已完成

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