飞书开放平台 Server API 文档

主题

更新外派信息 ​

更新指定的外派信息

Tip: - 部门岗职模式，会影响岗位、职务等字段的必填校验

  • 外派信息相关字段，会基于【飞书人事-人员档案配置】进行必填校验

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/employees/international_assignments/:international_assignment_id
HTTP MethodPATCH
接口频率限制10 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:employees.international_assignment:write 读写外派信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID corehr:employment.international_assignment.compensation_type:write 读写外派薪资类型 corehr:employment.international_assignment.custom_field:write 读写外派自定义字段 corehr:employment.international_assignment.job:write 读写外派职务 corehr:employment.international_assignment.job_grade:write 读写外派职等 corehr:employment.international_assignment.job_level:write 读写外派职级 corehr:employment.international_assignment.position:write 读写外派岗位 corehr:employment.international_assignment.service_company:write 读写外派公司 corehr:employment.international_assignment.weekly_working_hours:write 读写外派周工作时长 corehr:employment.international_assignment.work_calendar:write 读写外派工作日历 corehr:employment.international_assignment.work_location:write 读写外派地点 corehr:employment.international_assignment.work_shift:write 读写外派排班类型 corehr:employment.international_assignment.working_hours_type:write 读写外派工时制度

请求头 ​

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

路径参数 ​

名称类型描述
international_assignment_idstring外派ID - 可通过批量查询外派获取
示例值："7127921432117937708"

查询参数 ​

名称类型必填描述
client_tokenstring否幂等标识，服务端会忽略client_token重复的请求
示例值：12454646
数据校验规则：
- 长度范围：1 ～ 100 字符
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: 以飞书人事的 ID 来识别用户
默认值：open_id
当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID
department_id_typestring否此次调用中使用的部门 ID 类型
示例值：open_department_id
可选值有：
- open_department_id: 以 open_department_id 来标识部门 - department_id: 以 department_id 来标识部门 - people_corehr_department_id: 以 people_corehr_department_id 来标识部门
默认值：open_department_id

请求体 ​

名称类型必填描述
work_location_idstring否外派工作地点 ID - 可通过【批量查询地点】获取，并选择【地点用途】为外派地点（international_assignment）的记录 - 该字段可不传，但不可传空值
示例值："7127921432117937708"
service_companystring否外派任职公司 ID - 可通过【批量查询公司】获取
示例值："7127921432117937708"
work_shiftstring否排班类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：work_shift
示例值："work_shift"
weekly_working_hours_v2number(float)否周工作时长 - 限制两位小数
示例值：8
数据校验规则：
- 取值范围：0 ～ 168
working_hours_type_idstring否工时制度ID - 可通过【批量查询工时制度】获取
示例值："7127921432117937708"
employee_type_idstring否人员类型ID - 可通过【批量查询人员类型】获取
示例值："7127921432117937708"
department_idstring否部门 ID - 可通过【批量查询部门】获取 - 类型与 department_id_type 一致
示例值："7127921432117937708"
job_idstring否职务 ID - 可通过【批量查询职务】获取
示例值："7127921432117937708"
job_family_idstring否序列 ID - 可通过【批量查询序列】获取
示例值："7127921432117937708"
job_level_idstring否职级 ID - 可通过【批量查询职级】获取
示例值："7127921432117937708"
job_grade_idstring否职等 ID - 可通过【查询职等】获取
示例值："7127921432117937708"
compensation_typestring否薪资类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：compensation_type
示例值："daily"
direct_manager_idstring否直属上级雇佣 ID - 可通过【批量查询员工信息】获取 - 类型与 user_id_type 一致
示例值："7127921432117937708"
dotted_line_manager_idstring否虚线上级雇佣 ID - 可通过【批量查询员工信息】获取 - 类型与 user_id_type 一致
示例值："7127921432117937708"
work_calendar_idstring否工作日历 ID - 可通过【查询工作日历】获取
示例值："7127921432117937708"
position_idstring否岗位 ID - 功能灰度中，请联系技术支持
示例值："7127921432117937708"
custom_fieldsobject_field_data\[\]否自定义字段 - 请参考【自定义字段说明】
数据校验规则：
- 长度范围：0 ～ 180
  └ field_namestring是字段名
示例值："name"
  └ valuestring是字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05])
示例值："Sandy"
international_assignment_reasonstring否外派原因说明
示例值："xxx 项目派遣"
数据校验规则：
- 长度范围：0 ～ 5000 字符
descriptionstring否备注
示例值："xxx 项目"
数据校验规则：
- 长度范围：0 ～ 10000 字符
international_assignment_expected_end_datestring否预计结束日期 - 格式：yyyy-mm-dd
示例值："2024-01-02"
international_assignment_typestring否外派类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：international_assignment - custom_api_name：international_assignment_type
示例值："global_assignment"
effective_timestring否开始日期 - 格式：yyyy-mm-dd
示例值："2024-01-02"
expiration_timestring否结束日期 - 格式：yyyy-mm-dd
示例值："2024-01-02"

请求体示例 ​

json
{
    "work_location_id": "7127921432117937708",
    "service_company": "7127921432117937708",
    "work_shift": "work_shift",
    "weekly_working_hours_v2": 8,
    "working_hours_type_id": "7127921432117937708",
    "employee_type_id": "7127921432117937708",
    "department_id": "7127921432117937708",
    "job_id": "7127921432117937708",
    "job_family_id": "7127921432117937708",
    "job_level_id": "7127921432117937708",
    "job_grade_id": "7127921432117937708",
    "compensation_type": "daily",
    "direct_manager_id": "7127921432117937708",
    "dotted_line_manager_id": "7127921432117937708",
    "work_calendar_id": "7127921432117937708",
    "position_id": "7127921432117937708",
    "custom_fields": [
        {
            "field_name": "name",
            "value": "Sandy"
        }
    ],
    "international_assignment_reason": "xxx 项目派遣",
    "description": "xxx 项目",
    "international_assignment_expected_end_date": "2024-01-02",
    "international_assignment_type": "global_assignment",
    "effective_time": "2024-01-02",
    "expiration_time": "2024-01-02"
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ international_assignmentemployees.international_assignment_resp外派信息
    └ work_location_idstring外派工作地点 ID - 可通过【查询单个地点】获取详细信息
字段权限要求： corehr:employment.international_assignment.work_location:write 读写外派地点
    └ service_companystring外派任职公司 ID - 可通过【查询单个公司】获取详细信息
字段权限要求： corehr:employment.international_assignment.service_company:write 读写外派公司
    └ work_shiftenum排班类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：work_shift
字段权限要求： corehr:employment.international_assignment.work_shift:write 读写外派排班类型
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言编码（IETF BCP 47）
        └ valuestring文本内容
    └ working_hours_type_idstring工时制度ID - 可通过【查询单个工时制度】获取详细信息
字段权限要求： corehr:employment.international_assignment.working_hours_type:write 读写外派工时制度
    └ employee_type_idstring人员类型ID - 可通过【查询单个人员类型】获取详细信息
    └ weekly_working_hours_v2number(float)周工作时长
字段权限要求： corehr:employment.international_assignment.weekly_working_hours:write 读写外派周工作时长
    └ department_idstring部门 ID - 可通过【查询单个部门】获取详细信息 - 类型与 department_id_type 一致
    └ job_idstring职务 ID - 可通过【查询单个职务】获取详细信息
字段权限要求： corehr:employment.international_assignment.job:write 读写外派职务
    └ job_family_idstring序列 ID - 可通过【查询单个序列】获取详细信息
字段权限要求： corehr:employment.international_assignment.job_level:write 读写外派职级
    └ job_level_idstring职级 ID - 可通过【查询单个职级】获取详细信息
    └ job_grade_idstring职等 ID - 可通过【查询职等】获取详细信息
字段权限要求： corehr:employment.international_assignment.job_grade:write 读写外派职等
    └ compensation_typeenum薪资类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：job_data - custom_api_name：compensation_type
字段权限要求： corehr:employment.international_assignment.compensation_type:write 读写外派薪资类型
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言编码（IETF BCP 47）
        └ valuestring文本内容
    └ direct_manager_idstring直属上级雇佣 ID - 可通过【批量查询员工信息】获取详细信息 - 类型与 user_id_type 一致
    └ dotted_line_manager_idstring虚线上级雇佣 ID - 可通过【批量查询员工信息】获取详细信息 - 类型与 user_id_type 一致
    └ work_calendar_idstring工作日历 ID - 可通过【查询工作日历】获取详细信息
字段权限要求： corehr:employment.international_assignment.work_calendar:write 读写外派工作日历
    └ position_idstring岗位 ID - 功能灰度中，请联系技术支持
字段权限要求： corehr:employment.international_assignment.position:write 读写外派岗位
    └ employment_idstring雇佣 ID - 可通过【批量查询员工信息】获取详细信息 - 类型与 user_id_type 一致
    └ custom_fieldsobject_field_data\[\]自定义字段 - 请参考【自定义字段说明】
字段权限要求： corehr:employment.international_assignment.custom_field:write 读写外派自定义字段
      └ field_namestring字段名
      └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(123, 123.23, true, ["id1","id2], 2006-01-02 15:04:05])
    └ international_assignment_reasonstring外派原因说明
    └ descriptionstring备注
    └ international_assignment_expected_end_datestring预计结束日期 - 格式：yyyy-mm-dd
    └ international_assignment_statusenum外派状态 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：international_assignment - custom_api_name：international_assignment_status
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言编码（IETF BCP 47）
        └ valuestring文本内容
    └ international_assignment_typeenum外派类型 - 可通过【获取字段详情】接口查询，查询参数如下： - object_api_name：international_assignment - custom_api_name：international_assignment_type
      └ enum_namestring枚举值
      └ displayi18n\[\]枚举多语展示
        └ langstring语言编码（IETF BCP 47）
        └ valuestring文本内容
    └ effective_timestring开始日期 - 格式：yyyy-mm-dd
    └ expiration_timestring结束日期 - 格式：yyyy-mm-dd - 在外派未结束时，该值默认为 9999-12-31
    └ idstring外派ID

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "international_assignment": {
            "work_location_id": "7127921432117937708",
            "service_company": "7127921432117937708",
            "work_shift": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ]
            },
            "working_hours_type_id": "7127921432117937708",
            "employee_type_id": "7127921432117937708",
            "weekly_working_hours_v2": 8,
            "department_id": "7127921432117937708",
            "job_id": "7127921432117937708",
            "job_family_id": "7127921432117937708",
            "job_level_id": "7127921432117937708",
            "job_grade_id": "7127921432117937708",
            "compensation_type": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ]
            },
            "direct_manager_id": "7127921432117937708",
            "dotted_line_manager_id": "7127921432117937708",
            "work_calendar_id": "7127921432117937708",
            "position_id": "7127921432117937708",
            "employment_id": "7127921432117937708",
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "Sandy"
                }
            ],
            "international_assignment_reason": "xxx 项目派遣",
            "description": "xxx 项目",
            "international_assignment_expected_end_date": "2024-01-02",
            "international_assignment_status": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ]
            },
            "international_assignment_type": {
                "enum_name": "phone_type",
                "display": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ]
            },
            "effective_time": "2024-01-02",
            "expiration_time": "2024-01-02",
            "id": "7127921432117937708"
        }
    }
}

错误码 ​

HTTP状态码错误码描述排查建议
4001160001参数错误请检查参数，必要情况请参照【飞书人事-档案配置】
5001160002未知错误请重试或联系技术支持

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

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