更新单个职级
该接口通过职级ID更新单个职级信息,包括职级数值、名称等信息。
Tip: 所有非必填参数不传值时则不更新数据
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v1/job_levels/:job_level_id |
| HTTP Method | PATCH |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:corehr 更新核心人事信息 corehr:job_level:write 读写职级信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
job_level_id | string | 职级ID。ID获取方式: - 调用【新建职级】【查询租户的职级信息】等接口可以返回职级ID 示例值:"1616161616" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
client_token | string | 否 | 根据client_token是否一致来判断是否为同一请求 示例值:12454646 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
level_order | int | 否 | 职级数值,单位:级。该字段主要用来在职级大小,职级的数值越大,代表职级越高 - 如果不填该字段则不更新 示例值:10 |
code | string | 否 | 职级编码。非必填字段,如果非空值会校验全局唯一性,如果传空值则不参与全局校验。 - 不传值时默认不更新此字段,保持原值 示例值:"J001" |
name | i18n\[\] | 否 | 职级名称,注意事项: - 包含lang(语言)和value(职级名称)两个子参数,更新时需同时提供 - 不传值时默认不更新此字段,保持原值 |
└ lang | string | 是 | 名称信息的语言,中文用zh-CN,英文用en-US - 最小1字符,最大200字符 示例值:"zh-CN" |
└ value | string | 是 | 名称信息的内容 - 最小1字符,最大200字符 - 名称不能包含「/」「;」「;」「\」「'」字符 示例值:"P5" |
description | i18n\[\] | 否 | 描述 - 不传值时默认不更新此字段,保持原值 |
└ lang | string | 是 | 描述信息的语言 - 最小1字符,最大200字符 示例值:"zh-CN" |
└ value | string | 是 | 描述信息的内容 - 最小1字符,最大200字符 示例值:"普通职级" |
active | boolean | 否 | 是否启用,true为启用,false为停用 - 不传值时默认不更新此字段,保持原值 示例值:true |
custom_fields | object_field_data\[\] | 否 | 自定义字段(该字段暂时不支持) - 不传值时默认不更新此字段,保持原值 - 包含filed_name(字段名)和value(字段值)两个子参数,更新时需同时提供 |
└ field_name | string | 是 | 字段名 - 最小1字符,最大200字符 示例值:"name" |
└ value | string | 是 | 字段值,是json转义后的字符串,具体传值方式参见获取自定义字段的元数据 - 最小1字符,最大200字符 示例值:""Sandy"" |
job_grade | string\[\] | 否 | 职等 ID 列表 - 不传值时默认不更新此字段,保持原值。 示例值:["4692446793125560154"] |
pathway_ids | string\[\] | 否 | 通道ID,详情可以参考【获取通道信息】 - 不传值时默认不更新此字段,保持原值。 示例值:["4719519211875096301"] |
view_order | int | 否 | 排序 - 数值越小,排序越靠前 示例值:123 数据校验规则: - 取值范围: 1 ~ 999999 |
请求体示例
json
{
"level_order": 10,
"code": "J001",
"name": [
{
"lang": "zh-CN",
"value": "P5"
}
],
"description": [
{
"lang": "zh-CN",
"value": "普通职级"
}
],
"active": true,
"custom_fields": [
{
"field_name": "name",
"value": "\"Sandy\""
}
],
"job_grade": [
"4692446793125560154"
],
"pathway_ids": [
"4719519211875096301"
],
"view_order": 123
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ job_level | job_level | 职级 |
└ id | string | 职级 ID |
└ level_order | int | 职级数值,单位:级 |
└ code | string | 编码 |
└ name | i18n\[\] | 名称 |
└ lang | string | 名称信息的语言 |
└ value | string | 名称信息的内容 |
└ description | i18n\[\] | 描述 |
└ lang | string | 描述信息的语言 |
└ value | string | 描述信息的内容 |
└ active | boolean | 是否启用 |
└ custom_fields | object_field_data\[\] | 自定义字段(该功能暂不支持,可忽略) |
└ field_name | string | 自定义字段 API Name,即自定义字段的唯一标识 |
└ value | string | 自定义字段值 |
└ job_grade | string\[\] | 职等 ID 列表 |
└ pathway_ids | string\[\] | 通道ID,详情可以参考【获取通道信息】 |
└ view_order | int | 排序 (数值越小,排序越靠前) |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"job_level": {
"id": "4692446793125560154",
"level_order": 10,
"code": "J001",
"name": [
{
"lang": "zh-CN",
"value": "P5"
}
],
"description": [
{
"lang": "zh-CN",
"value": "普通职级"
}
],
"active": true,
"custom_fields": [
{
"field_name": "name",
"value": "\"工程师\""
}
],
"job_grade": [
"4692446793125560154"
],
"pathway_ids": [
"4719519211875096301"
],
"view_order": 123
}
}
}