飞书开放平台 Server API 文档

主题

编辑离职信息 ​

该接口用于编辑飞书人事的离职信息，支持的字段包括离职日期、离职原因、离职申请发起时间和离职申请审批通过时间等等，同时也支持编辑离职的自定义字段（附件字段除外）。当接口成功提交后，会产生对应的离职信息变更事件。

Tip: 注意：该接口会按照应用拥有的「员工数据」的权限范围返回数据，请确定在「开发者后台 - 权限管理 - 数据权限-飞书人事（企业版）数据权限」中申请了「员工资源」权限范围。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/offboardings/edit
HTTP MethodPOST
接口频率限制20 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:offboarding.update:write 编辑离职信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头 ​

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

查询参数 ​

名称类型必填描述
user_id_typestring否用户 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_idstring是离职记录ID，不允许为空。可以通过搜索离职信息获取，取值于接口返回的data > items > offboarding_id
示例值："7095671727698478604"
operator_idstring否操作人雇佣 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"
update_dataobject_field_data\[\]是编辑字段数据信息，不允许为空。
数据校验规则：
- 长度范围：0 ～ 10000
  └ field_namestring是字段唯一标识 （api_name）
注意：
1.该字段取值于人员档案配置 > 信息配置 > 离职信息 中各字段的字段编码
2.自定义字段也可以通过获取自定义字段列表获取
3.不可编辑的字段api_name 范围：
-wk_id
-wk_tenant_id
-employment
-process_id
-flow_id
-node_id
-initiator_id
-status
-checklist_status
-checklist_process_id
-type,hrbp_ids
-hrbp_list<br>-probation_id
-wk_created_at
-wk_created_by
-wk_updated_at
-wk_updated_by
-wk_deleted_at
-wk_is_deleted
-noncompete_agreement_id
-social_insurance_end_date
-provident_fund_end_date
-sign_type
示例值："name"
  └ valuestring是字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同，例如：
-文本类型（1）:"文本"
-布尔类型（2）:"true"
-数字类型（3）:"123"
-单值枚举类型（4）:"option_1"
-多值枚举类型（4）："["option_1","option_2"]"
-日期类型（7）:"2024-06-30"
注意：
1.枚举字段的枚举值取值于人员档案配置 > 信息配置 > 离职信息 对应字段选项集的选项编码。
2.枚举字段值也可通过获取字段详情获取，参考接口返回的 字段详情 > 字段类型配置信息 > 选项配置信息 > 选项信息 > 枚举常量集 API name
3.人员字段目前只支持传入员工的雇佣ID。先参考如何获取自己的 User ID获取User ID。然后通过ID 转换获取雇佣ID。
4.暂不支持填写附件类型字段。
示例值："Sandy"

请求体示例 ​

json
{
    "offboarding_id": "7095671727698478604",
    "operator_id": "6982509313466189341",
    "update_data": [
        {
            "field_name": "name",
            "value": "Sandy"
        }
    ]
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ dataobject_field_data\[\]编辑字段数据信息
    └ field_namestring字段名
    └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05])

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "data": [
            {
                "field_name": "name",
                "value": "Sandy"
            }
        ]
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001160103general internal server error code系统出现问题，如需帮助，请咨询技术支持。
4001160102parameter is illegal入参不合法，请检查offboarding_id和update_data参数后重新提交
4001160203no current contract离职日期当天无有效的合同，请检查员工合同数据后重新提交
4001160204has future contract存在未来生效的合同，请检查员工合同数据后重新提交
4001160205contract has actual end date合同已存在实际结束日期，请检查员工合同数据后重新提交
4001160602offboarding is earlier than probation离职日期早于试用期开始日期，请检查员工试用期开始日期和离职日期后重新提交
4001160603offboarding is earlier than transform离职日期早于异动生效日期，请检查员工最后一条异动生效日期和离职日期后重新提交
4001160604reason explanation length exceed maximum离职原因说明或离职原因说明（员工）长度超过6000个字符，请检查长度后重新提交
4001160607offboarding is earlier than contract start date离职日期早于合同开始日期，请检查员工合同数据后重新提交
4001160608offboarding is later than contract end date离职日期晚于合同结束日期，请检查员工合同数据后重新提交
4001160610has no permission to edit this offboarding无权限编辑该离职，请检查应用的飞书人事（企业版）数据权限范围后重新提交
4001160710invalid block list屏蔽名单相关字段不合法，请检查屏蔽名单相关字段后重新提交
4001160200has approving transform存在审批中的异动，请撤销后重新提交
4001160601offboarding is earlier than onboarding离职日期早于入职日期，请检查离职日期后重新提交
4001160617hyperlink field format is illegal超链接字段格式不合法，请检查编辑字段后重新提交
4001160618text field exceeds maximum limit文本字段超过长度限制，单行文本不应超过255个字符，多行文本不应超过6000个字符,请检查编辑字段后重新提交
4001160619enum value of the enum field is invalid枚举字段值无效，请确认是否存在该枚举值后重新提交
4001160623not allowed to edit this offboarding不允许编辑，请确认离职流程审批通过且编辑字段在允许的范围内后重新提交
4001160624operator does not exist操作人ID不存在，请确认操作人是否存在后重新提交
4001160625offboarding does not exist离职ID不存在，请检查离职是否存在后重新提交
4001160631employee is not exist or has offboarded员工已离职或不存在，请检查离职员工是否存在后重新提交
4001160636custom employment does not exist自定义人员字段ID不存在，请检查填写的员工是否存在后重新提交
4001160637not support edit attachment不支持编辑附件类型字段，请检查提交数据是否包含附件类型字段后重新提交
4001160638invalid date time value日期类型字段值不合法，请检查提交数据中的日期类型字段后重新提交
4001160639invalid bool value布尔类型字段值不合法，请检查提交数据中的布尔类型字段后重新提交
4001160700non compete agreement field value is illegal竞业相关字段不合法，请确认竞业信息字段后重新提交
4001160304company id not found公司ID不存在，请检查填写的公司是否存在后重新提交
4001160300the department has been disable on the date of offboarding离职日期当天部门已停用，请检查离职日期后重新提交
4001160630invalid number value数字类型字段格式不合法，请检查提交数据中的数字类型字段后重新提交
4001161000unknown error系统出现问题，如需帮助，请咨询技术支持。
4001161001The current offboarding record is under modification approval; it cannot be edited.当前离职记录正在进行变更审批，不可编辑，请检查离职信息最新的状态
4001161002The current offboarding record is under withdrawal approval; it cannot be edited.当前离职记录正在进行撤销审批，不可编辑，请检查离职信息最新的状态

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

本镜像仅供学习与查阅，文档版权归飞书所有