获取绩效周期人员信息
获取指定绩效周期下,被评估人在评估时的部门、序列、职级等人员信息。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/performance/v2/user_info/query |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据 |
| 字段权限要求 | > Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID performance:user_snapshot.department:read 查看员工在绩效周期的部门信息 performance:user_snapshot.direct_leader:read 查看员工在绩效周期的直属上级 performance:user_snapshot.job_family:read 查看员工在绩效周期的序列信息 performance:user_snapshot.job_level:read 查看员工在绩效周期的职级信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
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?默认值: open_id当值为 user_id,字段权限要求: contact:user.employee_id:readonly 获取用户 user ID |
department_id_type | string | 否 | 指定查询结果中的部门 ID 类型。关于部门 ID 的详细介绍,可参见部门 ID 说明。 示例值:open_department_id 可选值有: - department_id:支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id,因此在未删除的部门范围内 department_id 具有唯一性。 - open_department_id:由系统自动生成的部门 ID,ID 前缀固定为 od-,在租户内全局唯一。默认值: open_department_id |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
semester_id | string | 是 | 评估周期 ID 列表,semester_id 可通过【获取周期】获得 示例值:"6992035450862224940" |
user_ids | string\[\] | 是 | 人员 ID 列表,ID 类型与user_id_type 的取值一致 示例值:["ou_3245842393d09e9428ad4655da6e30b3"] 数据校验规则: - 长度范围: 0 ~ 10 |
请求体示例
json
{
"semester_id": "6992035450862224940",
"user_ids": [
"ou_3245842393d09e9428ad4655da6e30b3"
]
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ semester_id | string | 评估周期 ID |
└ user_infos | user_info\[\] | 人员的快照信息列表 |
└ user_id | user | 人员的用户 ID |
└ open_id | string | 用户的 open_id |
└ user_id | string | 用户的 user_id,取值与user_id_type一致 |
└ direct_leader_user_id | user | 人员的直属上级的用户 ID 字段权限要求: performance:user_snapshot.direct_leader:read 查看员工在绩效周期的直属上级 |
└ open_id | string | 人员的直属上级的 open_id |
└ user_id | string | 人员的直属上级的 user_id,取值与user_id_type一致 |
└ department | department | 人员的部门 字段权限要求: performance:user_snapshot.department:read 查看员工在绩效周期的部门信息 |
└ id | string | 部门 ID,与入参中的department_id_type类型一致,详情请查看:获取单个部门信息 |
└ name | i18n | 部门名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ job_family | job_family | 人员的序列 字段权限要求: performance:user_snapshot.job_family:read 查看员工在绩效周期的序列信息 |
└ id | string | 序列 ID |
└ name | i18n | 序列名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
└ job_level | job_level | 人员的职级 字段权限要求: performance:user_snapshot.job_level:read 查看员工在绩效周期的职级信息 |
└ id | string | 职级 ID |
└ name | i18n | 职级名称 |
└ zh_cn | string | 中文 |
└ en_us | string | 英文 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"semester_id": "6992035450862224940",
"user_infos": [
{
"user_id": {
"open_id": "od-asd2dasdasd",
"user_id": "ou-ux987dsf6x"
},
"direct_leader_user_id": {
"open_id": "od-xxx2dasdasd",
"user_id": "ou-xxx87dsf6x"
},
"department": {
"id": "od-4e6ac4d14bcd5071a37a39de902c7141",
"name": {
"zh_cn": "部门",
"en_us": "department"
}
},
"job_family": {
"id": "mga5oa8ayjlp9rb",
"name": {
"zh_cn": "序列",
"en_us": "Job family"
}
},
"job_level": {
"id": "mga5oa81212312",
"name": {
"zh_cn": "职级",
"en_us": "Job level"
}
}
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1580101 | internal error | 内部错误,请稍后重试,仍然出现可以咨询客服 |
| 400 | 1580102 | param is invalid | 检查传入的参数 |
| 400 | 1580901 | tenant no licnese | 租户无绩效席位,请联系租户管理员开通绩效席位 |
