飞书开放平台 Server API 文档

主题

更新单个职务 ​

可以通过职务ID更新单个职务详情信息，例如职务名称、描述等。

Tip: - 如果传入生效时间当天不存在版本则会自动生成一个版本。

  • 如果传入生效时间当天存在版本则会修改该版本。

请求 ​

项目值
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/jobs/:job_id
HTTP MethodPATCH
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可corehr:corehr 更新核心人事信息 corehr:job:write 读写职务信息

请求头 ​

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

路径参数 ​

名称类型描述
job_idstring职务ID。ID获取方式： - 调用【创建职务】【批量查询职务】等可以返回职务ID - 也可以通过【事件】创建职务 【事件】更新职务 获取ID
示例值："1616161616"

查询参数 ​

名称类型必填描述
client_tokenstring否根据client_token是否一致来判断是否为同一请求
示例值：12454646

请求体 ​

名称类型必填描述
codestring否职务编码 (不能与其他记录的编码重复)，当开启自动编码时，该字段会失效。 - 不传值时默认不更新此字段，保持原值
示例值："JP422119"
namei18n\[\]否职务名称。注意事项： - 名称不能包含「/」「；」「;」「\」「'」字符 - xx中英文名称会有全局唯一校验（已停用职务也会校验） - 不传值时默认不更新此字段，保持原值 - 包含lang（语言）和value（序列名称）两个子参数，更新时需同时提供
  └ langstring是语言信息，中文用zh-CN，英文用en-US。最小1字符，最大200字符
示例值："zh-CN"
  └ valuestring是名称信息的内容。最小1字符，最大200字符
示例值："软件工程师"
descriptioni18n\[\]否描述 - 不传值时默认不更新此字段，保持原值 - 包含lang（语言）和value（序列名称）两个子参数，更新时需同时提供
  └ langstring是语言信息，中文用zh-CN，英文用en-US。最小1字符，最大200字符
示例值："zh-CN"
  └ valuestring是描述信息的内容。最小1字符，最大200字符
示例值："负责后端开发工作"
activeboolean否是否启用，true为启用，fasle为停用。不传值时默认不更新此字段，保持原值
示例值：true
job_titlei18n\[\]否职务头衔 - 不传值时默认不更新此字段，保持原值 - 包含lang（语言）和value（序列名称）两个子参数，更新时需同时提供
  └ langstring是语言信息，中文用zh-CN，英文用en-US。最小1字符，最大200字符
示例值："zh-CN"
  └ valuestring是头衔信息的内容。最小1字符，最大200字符
示例值："高级"
pathway_idstring否通道ID，详情可以参考【获取通道信息】 - 不传值时默认不更新此字段，保持原值
示例值："4719519211875096301"
job_family_id_liststring\[\]否职务序列 ID 列表。ID获取方式： - 调用【新建序列】【查询租户的序列信息】等接口可以返回序列ID - 不传值时默认不更新此字段，保持原值
示例值：["4719519211875096301"]
job_level_id_liststring\[\]否职务级别 ID 列表。ID获取方式： - 调用【新建职级】【查询租户的职级信息】等接口可以返回职级ID - 不传值时默认不更新此字段，保持原值
示例值：["4719519212005299950"]
working_hours_type_idstring否工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得 - 不传值时默认不更新此字段，保持原值
示例值："6890452208593372679"
effective_timestring否版本生效日期 - 填写格式：YYYY-MM-DD 00:00:00（系统会自动将时分秒改为00:00:00） - 系统默认为填写日期当天的 00:00:00 生效 - 该接口只支持到最小单位为日 - 日期范围要求:1900-01-01 00:00:00～9999-12-31 23:59:59 - 不传值时默认不更新此字段，保持原值
示例值："2020-01-01 00:00:00"
custom_fieldsobject_field_data\[\]否自定义字段，格式参考：【自定义字段说明】岗位、职务、自定义组织模块 - 不传值时默认不更新此字段，保持原值
  └ field_namestring是字段名 - 最小1字符，最大200字符
示例值："name"
  └ valuestring是字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") - 最小1字符，最大200字符
示例值：""Sandy""

请求体示例 ​

json
{
    "code": "JP422119",
    "name": [
        {
            "lang": "zh-CN",
            "value": "软件工程师"
        }
    ],
    "description": [
        {
            "lang": "zh-CN",
            "value": "负责后端开发工作"
        }
    ],
    "active": true,
    "job_title": [
        {
            "lang": "zh-CN",
            "value": "高级"
        }
    ],
    "pathway_id": "4719519211875096301",
    "job_family_id_list": [
        "4719519211875096301"
    ],
    "job_level_id_list": [
        "4719519212005299950"
    ],
    "working_hours_type_id": "6890452208593372679",
    "effective_time": "2020-01-01 00:00:00",
    "custom_fields": [
        {
            "field_name": "name",
            "value": "\"Sandy\""
        }
    ]
}

响应 ​

响应体 ​

名称类型描述
codeint错误码，非 0 表示失败
msgstring错误描述
data\--
  └ jobjob职务
    └ idstring职务 ID
    └ codestring编码
    └ namei18n\[\]名称
      └ langstring名称信息的语言
      └ valuestring名称信息的内容
    └ descriptioni18n\[\]描述
      └ langstring名称信息的语言
      └ valuestring名称信息的内容
    └ activeboolean是否启用，true为启用，fasle为停用
    └ job_titlei18n\[\]职务头衔
      └ langstring名称信息的语言
      └ valuestring名称信息的内容
    └ pathway_idstring通道ID，详情可以参考【获取通道信息】
    └ job_family_id_liststring\[\]职务序列 ID 列表 - 可通过批量查询序列获取详情
    └ job_level_id_liststring\[\]职务级别 ID 列表 - 可通过批量查询职级获取详情
    └ working_hours_type_idstring工时制度 ID，枚举值及详细信息可通过【批量查询工时制度】接口查询获得
    └ effective_timestring当前版本生效日期 - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 00:00:00
    └ expiration_timestring当前版本失效日期 - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 00:00:00
    └ custom_fieldsobject_field_data\[\]自定义字段，格式参考：【自定义字段说明】岗位、职务、自定义组织模块
      └ field_namestring字段名
      └ valuestring字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")

响应体示例 ​

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "job": {
            "id": "4698040628992333549",
            "code": "JP422119",
            "name": [
                {
                    "lang": "zh-CN",
                    "value": "软件工程师"
                }
            ],
            "description": [
                {
                    "lang": "zh-CN",
                    "value": "负责后端开发工作"
                }
            ],
            "active": true,
            "job_title": [
                {
                    "lang": "zh-CN",
                    "value": "高级"
                }
            ],
            "pathway_id": "4719519211875096301",
            "job_family_id_list": [
                "4719519211875096301"
            ],
            "job_level_id_list": [
                "4719519212005299950"
            ],
            "working_hours_type_id": "6890452208593372679",
            "effective_time": "2020-01-01 00:00:00",
            "expiration_time": "2021-01-01 00:00:00",
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "\"Sandy\""
                }
            ]
        }
    }
}

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

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