获取评估项列表
批量获取评估项信息,如评估项名称、评估项类型、评估项等级配置等信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/performance/v2/indicators/query |
| HTTP Method | POST |
| 接口频率限制 | 10 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据 performance:review_template:read 获取评估配置信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0= |
page_size | int | 否 | 分页大小 示例值:30 默认值: 20数据校验规则: - 取值范围: 0 ~ 50 |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
indicator_ids | string\[\] | 否 | 评估项 ID 列表,填写时获取指定的评估项,不填时返回所有评估项 示例值:["7343513161666707459"] 数据校验规则: - 长度范围: 0 ~ 50 |
请求体示例
json
{
"indicator_ids": [
"7343513161666707459"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ indicators | indicator\[\] | 评估项列表 |
└ id | string | 评估项 ID |
└ name | i18n | 评估项名称 |
└ zh_cn | string | 评估项中文名称 |
└ en_us | string | 评估项英文名称 |
└ type | string | 评估项类型 可选值有: - general_review_item: 常规评估项 - review_item_based_on_key_metric: 关键指标评估项 - okr_review_item: OKR 评估项 - plus: 加分项 - minus: 减分项 |
└ options | indicator_option\[\] | 评估项等级列表 |
└ id | string | 评估项等级 ID |
└ name | i18n | 评估项等级名称 |
└ zh_cn | string | 评估项等级中文名称 |
└ en_us | string | 评估项等级英文名称 |
└ lable | string | 评估项等级代号 |
└ has_more | boolean | 是否还有更多项 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"indicators": [
{
"id": "7343513161666707459",
"name": {
"zh_cn": "完成度",
"en_us": "Completeness"
},
"type": "plus",
"options": [
{
"id": "7343513161666707459",
"name": {
"zh_cn": "等级 1",
"en_us": "Rank 1"
},
"lable": "qwerty"
}
]
}
],
"has_more": true,
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1580102 | param is invalid | 检查参数是否正确,例如类型,大小 |
| 500 | 1580101 | internal error | 请根据实际报错信息定位或咨询技术支持 |
更多错误码信息,参见通用错误码。
