Skip to content

查询单个序列详情

该接口通过序列ID查询单个序列详情信息,如序列名称、描述、状态等

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

Tip: 如果你需要批量序列查询场景,建议通过批量查询序列信息获取序列信息。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v1/job_families/:job_family_id
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

路径参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ job_familyjob_family序列信息
    └ idstring序列 ID
    └ namei18n\[\]名称
      └ langstring语言信息,中文用zh-CN,英文用en-US
      └ valuestring名称信息的内容
    └ activeboolean是否启用
    └ selectableboolean是否可被使用,true为可被使用,false为不可被使用
    └ 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自定义字段(该字段暂时不支持)
      └ valuestring字段值,是json转义后的字符串,根据元数据定义不同,字段格式不同(如123, 123.23, "true", ["id1","id2"], "2006-01-02 15:04:05")

响应体示例

json
{
    "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": "序列管理员",
                    "value": "\"Sandy\""
                }
            ]
        }
    }
}

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