撤销离职
通过离职ID撤销飞书人事的离职信息。当接口成功提交后,会产生对应的离职信息变更事件。
Tip: 注意:该接口会限制应用拥有的「员工数据」的权限范围撤销离职信息,请先在「开发者后台 - 权限管理 - 数据权限-飞书人事(企业版)数据权限」中申请「员工资源」权限范围。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/offboardings/revoke |
| HTTP Method | POST |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:offboarding.revoke:write 撤销离职申请 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
user_id_type | string | 否 | 用户 ID 类型 示例值:people_corehr_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: 以飞书人事的 ID 来识别用户默认值: people_corehr_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
offboarding_id | string | 是 | 离职记录ID,不允许为空。可以通过搜索离职信息获取,取值于接口返回的data > items > offboarding_id 示例值:"7095671727698478604" |
operator_id | string | 否 | 操作人雇佣 ID(employment_id),ID类型与查询参数 user_id_type取值一致: 1、当user_id_type取值为open_id时,ID获取方式参考如何获取自己的Open ID。 2、当user_id_type取值为user_id时,ID获取方式参考如何获取自己的 User ID。 3、当user_id_type取值为union_id时,ID获取方式参考如何获取自己的 Union ID。 4、当user_id_type取值为people_corehr_id时,先参考如何获取自己的 User ID获取User ID。然后通过ID 转换获取雇佣ID。 注意:为空时,默认系统操作人 示例值:"6982509313466189341" |
请求体示例
json
{
"offboarding_id": "7095671727698478604",
"operator_id": "6982509313466189341"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1160103 | general internal server error code | 系统出现问题,如需帮助,请咨询技术支持。 |
| 400 | 1160102 | parameter is illegal | 入参不合法,请检查offboarding_id后重新提交 |
| 400 | 1160101 | unknown error | 系统出现问题,如需帮助,请咨询技术支持。 |
| 400 | 1160201 | offboarding is not exist | 离职ID不存在,请检查填写离职ID是否有真实的离职数据 |
| 400 | 1160202 | offboarding has been withdrawn | 离职已被撤销,请检查离职信息最新的状态 |
| 400 | 1160203 | the department has been disable when withdrawn | 员工所在部门已失效,请先将离职人员变更到启用的部门后再撤销离职信息 |
| 400 | 1160204 | can not been withrawn in the same time | 不允许同时撤销同一个离职信息,请稍后重试 |
| 400 | 1160205 | The current offboarding record is under modification approval; it cannot be withdrawn. | 当前离职记录正在进行变更审批,不可撤销,请检查离职信息最新的状态 |
| 400 | 1160206 | The current offboarding record is under withdrawal approval; it cannot be withdrawn. | 当前离职记录正在进行撤销审批,不可撤销,请检查离职信息最新的状态 |
