更新单个序列

可以通过序列ID更新单个序列详情信息，例如序列名称、上级序列ID等。

Tip: 接口调用成功后，可以通过通过序列 ID 批量获取序列信息 查询到最新信息

• 由于数据库主从延迟，一般2-3秒后能查询到最新数据
• 如果传入生效时间当天不存在版本则会自动生成一个版本。
• 如果传入生效时间当天存在版本则会修改该版本。

请求

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

请求头

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

路径参数

名称	类型	描述
job_family_id	string	序列ID。ID获取方式： - 调用【新建序列】【查询租户的序列信息】等接口可以返回序列ID 示例值："1616161616"

查询参数

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

请求体

名称	类型	必填	描述
name	i18n\[\]	否	序列名称。不传值时默认不更新此字段，保持原值 - 包含lang（语言）和value（序列名称）两个子参数，更新时需同时提供
└ lang	string	是	语言信息，中文用zh-CN，英文用en-US 示例值："zh-CN"
└ value	string	是	序列名称。最小1字符，最大200字符 - 名称不能包含「/」「；」「;」「\」「'」字符。 - 序列中英文名称会有全局唯一校验 - 语言需与lang参数的取值一致 示例值："研发序列"
active	boolean	否	是否启用，true为启用，false为停用。不传值时默认不更新此字段，保持原值 示例值：true
selectable	boolean	否	是否可被使用，true为可被使用，false为不可被使用。不传值时默认不更新此字段，保持原值 示例值：true
parent_id	string	否	上级序列ID。不传值时默认不更新此字段，保持原值。 - ID获取方式：调用【新建序列】【查询租户的序列信息】等接口可以返回序列ID 示例值："4698020757495316313"
pathway_ids	string\[\]	否	通道ID，不传值时默认不更新此字段，保持原值。 - 详情可以参考获取通道信息 示例值：["4719519211875096301"]
effective_time	string	否	版本生效日期。不传值时默认不更新此字段，保持原值 - 填写格式：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-05-01 00:00:00"
code	string	否	序列编码 (不能与其他记录的编码重复)。不传值时默认不更新此字段，保持原值。 - 开启自动编码时，如果不传值会自动生成编码，否则以传入值为准 - 未开启自动编码时，不传值不会自动生成编码 示例值："123456"
description	i18n\[\]	否	描述。不传值时默认不更新此字段，保持原值。 - 包含lang（语言）和value（序列名称）两个子参数，更新时需同时提供
└ lang	string	是	语言，中文用zh-CN，英文用en-US 示例值："zh-CN"
└ value	string	是	内容 - 最小1字符，最大200字符 示例值："这是一个技术序列的描述"
custom_fields	object_field_data\[\]	否	自定义字段（该字段暂时不支持），注意事项： - 包含field_name（字段名）和value（字段值）两个子参数，更新时需同时提供 - 不传值时默认不更新此字段，保持原值
└ field_name	string	是	自定义字段 API Name，即自定义字段的唯一标识 - 最小1字符，最大200字符 示例值："name"
└ value	string	是	字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05") - 最小1字符，最大200字符 示例值：""Sandy""

请求体示例

{
    "name": [
        {
            "lang": "zh-CN",
            "value": "研发序列"
        }
    ],
    "active": true,
    "selectable": true,
    "parent_id": "4698020757495316313",
    "pathway_ids": [
        "4719519211875096301"
    ],
    "effective_time": "2020-05-01 00:00:00",
    "code": "123456",
    "description": [
        {
            "lang": "zh-CN",
            "value": "这是一个技术序列的描述"
        }
    ],
    "custom_fields": [
        {
            "field_name": "name",
            "value": "\"Sandy\""
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ job_family	job_family	序列
└ id	string	序列 ID
└ name	i18n\[\]	名称
└ lang	string	名称信息的语言
└ value	string	名称信息的内容
└ active	boolean	是否启用
└ selectable	boolean	是否可被使用，true为可被使用，false为不可被使用
└ parent_id	string	上级序列ID - 可通过批量查询序列获取详情
└ pathway_ids	string\[\]	通道ID，详情可以参考获取通道信息
└ effective_time	string	当前版本生效日期 - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 00:00:00
└ expiration_time	string	当前版本失效日期 - 返回格式：YYYY-MM-DD 00:00:00（最小单位到日） - 日期范围:1900-01-01 00:00:00～9999-12-31 00:00:00
└ code	string	序列编码
└ description	i18n\[\]	描述
└ lang	string	语言，中文用zh-CN，英文用en-US
└ value	string	内容
└ custom_fields	object_field_data\[\]	自定义字段（暂不支持该功能，可忽略）
└ field_name	string	字段名
└ value	string	字段值，是json转义后的字符串，根据元数据定义不同，字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "job_family": {
            "id": "4698019107896524633",
            "name": [
                {
                    "lang": "zh-CN",
                    "value": "张三"
                }
            ],
            "active": true,
            "selectable": true,
            "parent_id": "4698020757495316313",
            "pathway_ids": [
                "4719519211875096301"
            ],
            "effective_time": "2020-05-01 00:00:00",
            "expiration_time": "2020-05-02 00:00:00",
            "code": "123456",
            "description": [
                {
                    "lang": "zh-CN",
                    "value": "这是一个技术序列的描述"
                }
            ],
            "custom_fields": [
                {
                    "field_name": "name",
                    "value": "\"Sandy\""
                }
            ]
        }
    }
}