# 获取绩效模板
获取绩效模板信息，包括模版名称、执行角色、填写项类型等
## 请求
基本 |
---|---
HTTP URL | https://open.feishu.cn/open-apis/performance/v2/review_templates/query
HTTP Method | POST
接口频率限制 | [10 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 管理绩效数据(performance:performance)
查看绩效数据(performance:performance:readonly)
获取评估配置信息(performance:review_template:read)
### 请求头
名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer t-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
### 查询参数
名称 | 类型 | 必填 | 描述
---|---|---|---
page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
page_size | int | 否 | 分页大小
**示例值**：30
**默认值**：`20`
**数据校验规则**：
- 取值范围：`0` ～ `50`
### 请求体
名称 | 类型 | 必填 | 描述
---|---|---|---
review_template_ids | string\[\] | 否 | 绩效模板 ID 列表，获取指定绩效模板的配置数据。如果不传则返回所有
**示例值**：["7343513161666707459"]
**数据校验规则**：
- 长度范围：`0` ～ `50`
### 请求体示例
```json
{
"review_template_ids": [
"7343513161666707459"
]
}
```
## 响应
### 响应体
名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
review_templates | review_template\[\] | 绩效模板信息
templates | template\[\] | 环节模板列表
template_id | string | 环节模板 ID
name | i18n | 环节模板对应的环节名称
zh_cn | string | 中文
en_us | string | 英文
stage_type | string | 环节类型
枚举值：
- `summarize_key_outputs`: 工作总结环节
- `review`: 评估型环节
- `communication_and_open_result`: 结果沟通环节
- `view_result`: 绩效结果查看环节
- `calibration`: 校准环节
- `reconsideration`: 结果复议环节
review_stage_role | string | 评估型环节的执行人角色
枚举值：
- `reviewee`: 被评估人
- `invited_reviewer`: 360°评估人
- `solid_line_leader`: 实线上级
- `dotted_line_leader`: 虚线上级
- `secondary_solid_line_leader`: 第二实线上级
- `direct_project_leader`: 项目直属上级
- `custom_review_role`:自定义评估角色
review_stage_data_write_mode | string | 评估型环节评估模式
units | unit\[\] | 评估内容列表
unit_id | string | 评估内容 ID
name | i18n | 评估内容名称
zh_cn | string | 中文
en_us | string | 英文
fields | field\[\] | 评估题列表，指评估内容中的每个题，可能是评估项或者填写项
field_id | string | 评估题 ID
name | i18n | 如果是填写项，为填写项名称，字段可能为空值；如果是评估项，为评估项名称，字段不为空值；如果是标签填写题，为标签填写题名称，字段不为空值
zh_cn | string | 中文
en_us | string | 英文
indicator_id | string | 评估项 ID，详细信息请参考[获取评估项配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/indicator/query)
tag_based_question_id | string | 标签填写题 ID，详细信息请参考[获取标签填写题配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/performance-v2/question/query)
objective_text_qustion_title | i18n | O 的填写项标题
zh_cn | string | 中文
en_us | string | 英文
keyresult_text_qustion_title | i18n | KR 的填写项标题
zh_cn | string | 中文
en_us | string | 英文
parent_field_id | string | 关联的父级评估项 ID
kpi_template_id | string | 指标模板ID
review_template_id | string | 绩效模板 ID
name | i18n | 绩效模板名称
zh_cn | string | 中文
en_us | string | 英文
description | i18n | 绩效模板描述
zh_cn | string | 中文
en_us | string | 英文
status | string | 状态
枚举值：
- `to_be_configured`: 待完成配置
- `to_be_enabled`: 待启用
- `enabled`: 已启用
- `disabled`: 已停用
- `deleted`: 已删除但曾经被项目引用过
has_more | boolean | 是否还有更多项
page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token
### 响应体示例
```json
{
"code": 0,
"msg": "success",
"data": {
"review_templates": [
{
"templates": [
{
"template_id": "7343513161666707459",
"name": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"stage_type": "leader_review",
"review_stage_role": "reviewee",
"review_stage_data_write_mode": "cooperate,independent"
}
],
"units": [
{
"unit_id": "7343513161666723843",
"name": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"fields": [
{
"field_id": "7343513161666707459",
"name": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"indicator_id": "7343513161666707459",
"tag_based_question_id": "7343513161666707459",
"objective_text_qustion_title": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"keyresult_text_qustion_title": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"parent_field_id": "7343513161666707459",
"kpi_template_id": "7494252079230222371"
}
]
}
],
"review_template_id": "7343513161666723843",
"name": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"description": {
"zh_cn": "体验",
"en_us": "Interactive experience"
},
"status": "enabled"
}
],
"has_more": true,
"page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
}
}
```
### 错误码
HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1580102 | param is invalid | 检查传入的参数
500 | 1580101 | internal error | 内部错误，请稍后重试，仍然出现可以[咨询客服](https://applink.feishu.cn/client/helpdesk/open?id=6626260912531570952&extra=%7B%22channel%22%3A14%2C%22created_at%22%3A1614493146%2C%22scenario_id%22%3A6885151765134622721%2C%22signature%22%3A%22ca94c408b966dc1de2083e5bbcd418294c146e98%22%7D)
400 | 1580901 | tenant no licnese | 租户无绩效席位，请联系租户管理员开通绩效席位