Skip to content

批量查询成本中心版本信息

根据成本中心 ID 列表,批量查询开始结束时间内的所有成本中心版本信息,含成本中心名称、编码、上级成本中心、负责人、版本生效日期、版本失效日期、是否启用、描述等信息。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/corehr/v2/cost_centers/query_multi_timeline
HTTP MethodPOST
接口频率限制10 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用corehr:cost_center:read 查看成本中心信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称类型必填描述
page_sizeint分页大小,最大 100
示例值:100
数据校验规则
- 取值范围:1100
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:6891251722631890445
user_id_typestring用户 ID 类型
示例值:people_corehr_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID? - people_corehr_id: 以飞书人事的 ID 来识别用户
默认值people_corehr_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
cost_center_idsstring\[\]成本中心 ID 列表,详细信息可通过【搜索成本中心信息】接口查询获得
示例值:["7140964208476371111"]
数据校验规则
- 长度范围:110
effective_date_startstring生效日期开始(包含)
- 若不传入 effective_date_start 和 effective_date_end,默认返回当前生效版本。 - 支持单独传入:仅传 effective_date_start 时,返回该日期及之后生效的版本。 - 与 effective_date_end 同时传入时,返回两者交集范围内生效的版本
示例值:"2024-01-01"
数据校验规则
- 长度范围:1010 字符 - 正则校验:`^((([0-9]{3}[1-9]
effective_date_endstring生效日期结束(包含)
- 若不传入 effective_date_start 和 effective_date_end,默认返回当前生效版本。 - 支持单独传入:仅传 effective_date_end 时,返回该日期及之前生效的版本。 - 与 effective_date_start 同时传入时,返回两者交集范围内生效的版本。
示例值:"2024-12-31"
数据校验规则
- 长度范围:1010 字符 - 正则校验:`^((([0-9]{3}[1-9]
fieldsstring\[\]返回数据的字段列表,可选 - name:成本中心名称 - code:编码 - active:当前实体是否启用 - parent_cost_center_id: 上级成本中心ID - managers:成本中心负责人ID 列表 - description:成本中心描述 - effective_date:版本生效日期 - expiration_date:版本失效日期
示例值:["name"]
数据校验规则
- 长度范围:0100

请求体示例

json
{
    "cost_center_ids": [
        "7140964208476371111"
    ],
    "effective_date_start": "2024-01-01",
    "effective_date_end": "2024-12-31",
    "fields": [
        "name"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ itemscost_center_timeline\[\]成本中心信息
    └ cost_center_idstring成本中心ID,详细信息可通过【搜索成本中心信息】接口查询获得
    └ version_idstring成本中心版本ID
    └ namei18n\[\]成本中心名称
      └ langstring名称信息的语言,支持中文和英文。中文用zh-CN;英文用en-US
      └ valuestring文本内容
    └ codestring编码
    └ parent_cost_center_idstring上级成本中心ID
    └ managersstring\[\]成本中心负责人ID 列表,详细信息可通过【搜索员工信息】接口查询获得
    └ descriptioni18n\[\]成本中心描述
      └ langstring语言
      └ valuestring文本内容
    └ effective_datestring版本生效日期
    └ expiration_datestring版本失效日期
    └ activeboolean当前实体是否启用
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ has_moreboolean是否还有更多项

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "cost_center_id": "6969828847121885087",
                "version_id": "6969828847121885087",
                "name": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "code": "MDPD00000023",
                "parent_cost_center_id": "6862995757234914824",
                "managers": [
                    "6862995757234914824"
                ],
                "description": [
                    {
                        "lang": "zh-CN",
                        "value": "中文示例"
                    }
                ],
                "effective_date": "2020-01-01",
                "expiration_date": "2020-01-01",
                "active": true
            }
        ],
        "page_token": "6969828847121885087",
        "has_more": true
    }
}

错误码

HTTP状态码错误码描述排查建议
4001160001param is invalid请检查参数是否合法
5031161204Request timeout联系飞书人事 Oncall
4291161604QPS over limit联系飞书人事 Oncall

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