录入被评估人关键指标数据
批量录入指定周期中被评估人的关键指标数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/performance/v2/metric_details/import |
| HTTP Method | POST |
| 接口频率限制 | 10 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | performance:metric:write 管理关键指标数据 |
| 字段权限要求 | > 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" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
client_token | string | 是 | 根据 client_token 是否一致来判断是否为同一请求 示例值:12454646 数据校验规则: - 长度范围: 0 ~ 64 字符 |
user_id_type | string | 否 | 用户 ID 类型 示例值:open_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_admin_id: 以people_admin_id来识别用户默认值: open_id数据校验规则: - 长度范围: 0 ~ 999999999 字符当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
semester_id | string | 是 | 周期 ID,可通过获取周期接口获取 示例值:"7293040702907514899" |
import_record_name | string | 否 | 数据源录入人,在录入记录页面可以查看该记录名称。 示例值:"API录入" 默认值: API录入 |
imported_metrics | imported_metric\[\] | 是 | 指标明细列表 数据校验规则: - 长度范围: 1 ~ 50 |
└ reviewee_user_id | string | 是 | 被评估人 ID,与入参 user_id_type 类型一致示例值:"ou_3245842393d09e9428ad4655da6e30b3" |
└ metric_id | string | 是 | 指标 ID,可通过获取指标列表接口获取 示例值:"7272580325522276372" |
└ fields | imported_metric_field\[\] | 是 | 指标字段信息 数据校验规则: - 长度范围: 1 ~ 99 |
└ field_id | string | 是 | 指标字段 ID,可通过获取指标字段列表接口获取 示例值:"7283776005142675476" |
└ field_value | string | 否 | 字段值 示例值:"100" |
└ field_value_person | string | 否 | 字段值,当字段为人员信息时必填,与入参 user_id_type 类型一致示例值:"ou_3245842393d09e9428ad4655da6e30b3" |
请求体示例
json
{
"semester_id": "7293040702907514899",
"import_record_name": "API录入",
"imported_metrics": [
{
"reviewee_user_id": "ou_3245842393d09e9428ad4655da6e30b3",
"metric_id": "7272580325522276372",
"fields": [
{
"field_id": "7283776005142675476",
"field_value": "100",
"field_value_person": "ou_3245842393d09e9428ad4655da6e30b3"
}
]
}
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ import_record_id | string | 导入记录 ID |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"import_record_id": "7241404194141224979"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1580101 | internal error | 请根据实际报错信息定位或咨询技术支持 |
| 400 | 1580102 | param is invalid | 检查参数是否正确,例如类型,大小 |
| 400 | 1580105 | invalid semester ID | 周期 ID 不存在,请检查 semester_id 入参是否正确 |
| 400 | 1580110 | request ID repeat | client_token 重复,请检查 client_token 入参是否正确 |
| 400 | 1580112 | permission denied | 操作无权限的被评估人数据,请检查当前应用申请的被评估人数据范围 |
| 400 | 1580301 | field value type is invalid | 字段值类型不合法 |
| 400 | 1580302 | field_value is null | 必填字段的字段值不能为空 |
| 400 | 1580303 | field value length exceeds the limit | 字段值内容长度超出限制,检查字段值长度 |
| 400 | 1580304 | sum of weights for metrics exceeds 100% | 指标的权重之和超出 100% 限制 |
| 400 | 1580305 | filed id not found in the metric | 请求的指标字段 ID 不存在于对应指标中 |
| 400 | 1580306 | reviewee not found | 请求的用户未参与评估或者所在项目未启动 |
| 400 | 1580307 | duplicate metric for the same reviewee in request | 检查传入的内容中是否有重复,同一个被评估人不允许传入重复的指标 |
| 400 | 1580308 | duplicate field for the same metric in request | 检查传入的内容中是否有重复,被评估人的指标的一个字段只允许传入唯一的字段值 |
| 400 | 1580309 | input is not allowed after the deadline | 已经超过了录入截止时间 |
| 400 | 1580310 | old vision metrics can't be input | 不支持录入老版本的关键指标数据 |
| 400 | 1580311 | data input by admins can't be overwritten | 不支持录入管理员已填写的字段值 |
| 400 | 1580312 | reviewee's metrics not found | 检查用户录入的指标ID是否正确 |
| 400 | 1580901 | tenant no licnese | 租户无绩效席位,请联系租户管理员开通绩效席位 |
更多错误码信息,参见通用错误码。
