Skip to content

批量查询序列信息

该接口支持获取租户下的所有序列信息。

Warning: 延迟说明:数据库主从延迟 2s 以内,即:直接创建序列后2s内调用此接口可能查询不到数据。

Tip: 使用建议:序列数量过多时,可以通过多次循环调用该接口获取所有序列详情信息,包括序列编码、名称等。

请求

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

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

查询参数

名称类型必填描述
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:1231231987
page_sizestring分页大小,最大值支持传100 - 最少1个字符,最多200个字符
示例值:100

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsjob_family\[\]查询的序列信息
    └ idstring序列 ID
    └ namei18n\[\]名称
      └ langstring名称信息的语言,中文zh-CN,英文en-US
      └ valuestring名称信息的内容
    └ activeboolean是否启用
    └ selectableboolean可选
    └ parent_idstring上级序列 ID,详细信息可通过【查询单个序列】接口查询获得(若查询的是一级序列,则该字段不展示)
    └ pathway_idsstring\[\]通道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
    └ codestring序列编码
    └ descriptioni18n\[\]描述
      └ langstring语言
      └ valuestring内容
    └ custom_fieldsobject_field_data\[\]自定义字段(暂时不支持该功能)
      └ field_namestring自定义字段 API Name,即自定义字段的唯一标识
      └ valuestring字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "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": "HR-MG-001",
                "description": [
                    {
                        "lang": "zh-CN",
                        "value": "刘梓新"
                    }
                ],
                "custom_fields": [
                    {
                        "field_name": "name",
                        "value": "\"Sandy\""
                    }
                ]
            }
        ],
        "has_more": true,
        "page_token": "4698019107896524634"
    }
}

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