搜索成本中心信息
搜索成本中心信息;支持通过成本中心ID,成本中心名称,成本中心编码,成本中心上级搜索成本中心的信息,有分页功能。
Warning: - 请求体入参不填写默认为空,不参与筛选
- 所有筛选项可一起使用,之间为 AND 关系
- 数据库主从延迟 2s 以内,即:直接创建成本中心后2s内调用此接口可能查询不到数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/cost_centers/search |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | corehr:cost_center:read 查看成本中心信息 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 是 | 分页大小,最大 100 示例值:100 数据校验规则: - 取值范围: 1 ~ 100 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:6891251722631890445 |
user_id_type | string | 否 | 用户 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_id_list | string\[\] | 否 | 成本中心ID 列表 - 一次性最多传入100个成本中心ID 示例值:["7140964208476371111"] |
name_list | string\[\] | 否 | 成长中心名称列表,精确匹配 示例值:["技术部成本中心"] |
code | string | 否 | 成本中心编码 示例值:"MDPD00000023" |
parent_cost_center_id | string | 否 | 上级成本中心ID,可用于查询直接下级成本中心 示例值:"6862995757234914824" |
get_all_version | boolean | 否 | 是否获取所有成本中心版本,true 为获取成本中心所有版本记录,false 为仅获取当前生效的成本中心记录,默认为 false 当填写 true 并输入其他查询条件时,返回的是所有符合查询条件的版本信息 示例值:true 默认值: false |
请求体示例
json
{
"cost_center_id_list": [
"7140964208476371111"
],
"name_list": [
"技术部成本中心"
],
"code": "MDPD00000023",
"parent_cost_center_id": "6862995757234914824",
"get_all_version": true
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | cost_center.version\[\] | 成本中心信息 |
└ cost_center_id | string | 成本中心ID |
└ version_id | string | 成本中心版本ID |
└ name | i18n\[\] | 成本中心名称 |
└ lang | string | 信息的语言,支持中文和英文。中文用zh-CN;英文用en-US |
└ value | string | 内容 |
└ code | string | 编码 |
└ parent_cost_center_id | string | 上级成本中心ID - 若查询的是一级成本中心,则该字段不展示 |
└ managers | string\[\] | 成本中心负责人ID 列表,详细信息可通过【搜索员工信息】接口获取 |
└ description | i18n\[\] | 成本中心描述 |
└ lang | string | 信息的语言,支持中文和英文。中文用zh-CN;英文用en-US |
└ value | string | 内容 |
└ effective_time | string | 版本生效日期 - 返回格式:YYYY-MM-DD (最小单位到日) - 日期范围:1900-01-01 ~9999-12-31 |
└ expiration_time | string | 版本失效日期 - 返回格式:YYYY-MM-DD (最小单位到日) - 日期范围:1900-01-01 ~9999-12-31 |
└ active | boolean | 当前实体是否启用 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
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_time": "2020-01-01",
"expiration_time": "2020-01-01",
"active": true
}
],
"page_token": "6969828847121885087",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1160001 | param is invalid | 输入参数不合法 |
