Skip to content

根据条件批量查询序列信息

通过序列 ID 或序列 Code 批量查询当前生效版本序列的详情信息,包括序列名称、启用状态、上级序列等。

Tip: - 如果你只需要单一序列查询场景,建议通过【查询单个序列】获取序列信息。

  • 序列ID和序列Code可一起使用,之间为 AND 关系
  • 数据库主从延迟 2s 以内,即:直接创建序列后2s内调用此接口可能查询不到数据。

请求

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

请求头

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

请求体

名称类型必填描述
job_family_idsstring\[\]序列ID列表。 - 序列 ID 列表和序列 Code 列表至少有一项有值,否则接口将调用失败。 - 未设置时表示不筛选该条件 - ID获取方式:调用【创建序列】【批量查询序列】等接口可以返回序列ID
示例值:["1554548"]
数据校验规则
- 长度范围:0100
job_family_codesstring\[\]序列 Code 列表。 - 序列 ID 列表和序列 Code 列表至少有一项有值,否则接口将调用失败。 - 未设置时表示不筛选该条件 - Code获取方式:调用【创建序列】【批量查询序列】等接口可以返回序列Code
示例值:["122348"]
数据校验规则
- 长度范围:0100

请求体示例

json
{
   "job_family_ids": [
    "7485328827867711096",
    "7486375838641787444"
    ],
  "job_family_codes": [
    "code1110",
    "code1112",
    "code1114"
  ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemsjob_family\[\]查询的序列信息
    └ job_family_idstring序列 ID
    └ namei18n\[\]名称
      └ langstring语言编码(IETF BCP 47)
      └ valuestring文本内容
    └ activeboolean启用状态,启用为true,停用为false
    └ selectableboolean是否可被使用,true为可被使用,false为不可被使用
    └ parent_idstring上级序列 ID,详细信息可通过【查询单个序列】接口查询获得(若查询的是一级序列,则该字段不展示)
    └ pathway_idsstring\[\]通道ID,详情可以参考【获取通道信息】
    └ effective_timestring当前版本生效时间,返回格式:YYYY-MM-DD 00:00:00(最小单位到日)
    └ expiration_timestring当前版本失效时间,返回格式:YYYY-MM-DD 00:00:00(最小单位到日)
    └ codestring编码 (不能与其他记录的编码重复)
    └ descriptioni18n\[\]描述
      └ langstring语言编码(IETF BCP 47)
      └ valuestring文本内容
    └ custom_fieldscustom_field_data\[\]自定义字段(该字段暂时不支持)
      └ custom_api_namestring自定义字段 apiname,即自定义字段的唯一标识
      └ namecustom_name自定义字段名称
        └ zh_cnstring中文
        └ en_usstring英文
      └ typeint自定义字段类型 - 自定义字段详细见【获取自定义字段列表】
      └ valuestring字段值,是 json 转义后的字符串,根据元数据定义不同,字段格式不同(如 123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "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": [
                    {
                        "custom_api_name": "name",
                        "name": {
                            "zh_cn": "自定义姓名",
                            "en_us": "Custom Name"
                        },
                        "type": 1,
                        "value": "\"231\""
                    }
                ]
            }
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
4001160001Param is invalid参数错误,请确认请求参数是否符合接口传参规范

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