查询指定时间范围序列版本
- 接口支持查询出对象生效时间段在指定的start_date和end_date之间的版本
- 接口支持对象版本相关字段的查询和返回(默认返回id和version_id)
- 适用于需要回顾某段时间内对象版本变化的场景
Tip: 延迟说明:数据库主从延迟2s以内,即:直接创建对象后2s内调用此接口可能查询不到数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/job_families/query_multi_timeline |
| HTTP Method | POST |
| 接口频率限制 | 5 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:job_family:read 获取序列信息 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_ids | string\[\] | 是 | 序列ID。ID获取方式: - 调用【新建序列】【查询租户的序列信息】等接口可以返回序列ID 示例值:["7094136522860922111"] 数据校验规则: - 长度范围: 1 ~ 10 |
start_date | string | 否 | 查询开始时间(包含) - start_date 不能大于 end_date - 必填字段,无默认值 示例值:"2024-01-01" 数据校验规则: - 长度范围: 10 ~ 10 字符 - 正则校验:`^((([0-9]{3}[1-9] |
end_date | string | 否 | 查询结束时间(不包含) - 必填字段,无默认值 示例值:"2024-12-31" 数据校验规则: - 长度范围: 10 ~ 10 字符 - 正则校验:`^((([0-9]{3}[1-9] |
fields | string\[\] | 否 | 返回数据的字段列表,可选 - job_family_name:序列名称 - code:编码 - active:是否启用 - parent_job_family:上级序列 - selectable:是否可被使用 - pathway:通道 - description:描述 - effective_date:当前版本生效日期 - expiration_date:当前版本失效日期 - 无默认值,为空时只能查询到ID 示例值:["job_family_name"] 数据校验规则: - 长度范围: 0 ~ 100 |
请求体示例
json
{
"job_family_ids": [
"7094136522860922111"
],
"start_date": "2024-01-01",
"end_date": "2024-12-31",
"fields": [
"job_family_name"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | job_family_timeline\[\] | 序列信息 |
└ job_family_version_data | job_family_version_data\[\] | 序列版本信息 |
└ job_family_id | string | 序列 ID |
└ job_family_version_id | string | 序列版本 ID |
└ job_family_names | i18n\[\] | 序列名称 |
└ lang | string | 语言 - 中文用zh-CN,英文用en-US。 |
└ value | string | 文本内容 |
└ effective_date | string | 当前版本生效日期 - 返回格式:YYYY-MM-DD (最小单位到日) - 日期范围:1900-01-01 ~9999-12-31 - 详情可以参考时间轴介绍 |
└ expiration_date | string | 当前版本失效日期 - 返回格式:YYYY-MM-DD (最小单位到日) - 日期范围:1900-01-01 ~9999-12-31 - 详情可以参考时间轴介绍 |
└ active | boolean | 是否启用 |
└ descriptions | i18n\[\] | 描述 |
└ lang | string | 语言 - 中文用zh-CN,英文用en-US。 |
└ value | string | 文本内容 |
└ selectable | boolean | 是否可被使用,true为可被使用,false为不可被使用 |
└ parent_job_family_id | string | 上级序列 ID,详细信息可通过【查询单个序列】接口查询获得(若查询的是一级序列,则该字段不展示) |
└ pathway_ids | string\[\] | 通道ID,详情可以参考【获取通道信息】 |
└ code | string | 编码 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"job_family_version_data": [
{
"job_family_id": "4719456877659520852",
"job_family_version_id": "7238516215202170412",
"job_family_names": [
{
"lang": "zh-CN",
"value": "技术序列"
}
],
"effective_date": "2020-05-01",
"expiration_date": "2020-05-02",
"active": true,
"descriptions": [
{
"lang": "zh-CN",
"value": "负责软件产品设计与开发的序列"
}
],
"selectable": true,
"parent_job_family_id": "4698020757495316313",
"pathway_ids": [
"4719519211875096301"
],
"code": "123456"
}
]
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 503 | 1161204 | Request timeout | 接口超时,可尝试重试。如果无法解决可以联系飞书人事 技术支持 |
| 429 | 1161604 | QPS over limit | 接口请求次数超过接口频率限制,可尝试降低请求频率 |
