Skip to content

获取被评估人信息

获取绩效周期中被圈定到项目中的被评估人信息,包括未启动的项目。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/performance/v2/reviewees/query
HTTP MethodPOST
接口频率限制20 次/分钟
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据 performance:semester_user:read 获取周期人员信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

查询参数

名称类型必填描述
user_id_typestring用户 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
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID
page_tokenstring分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
page_sizeint分页大小
示例值:30
默认值20
数据校验规则
- 取值范围:150

请求体

名称类型必填描述
semester_idstring周期 ID,可通过获取周期列表 接口获取
示例值:"6992035450862224940"
user_idsstring\[\]用户 ID,与入参 user_id_type 类型一致,查询指定的被评估人信息
示例值:["ou_3245842393d09e9428ad4655da6e30b3"]
数据校验规则
- 长度范围:050
activity_idsstring\[\]项目 ID 列表,可通过获取项目列表 接口获取,查询指定的项目下的被评估人信息
示例值:["7266780609384392723"]

请求体示例

json
{
    "semester_id": "6992035450862224940",
    "user_ids": [
        "ou_3245842393d09e9428ad4655da6e30b3"
    ],
    "activity_ids": [
        "7266780609384392723"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ semester_idstring周期ID
  └ revieweesreviewee\[\]被评估人列表
    └ reviewee_user_iduser被评估人 ID
      └ open_idstring用户的 open_id
      └ user_idstring用户的 user_id,ID 类型与user_id_type 的取值一致
    └ activity_idsstring\[\]被评估人参与的项目,详细信息请参考获取项目配置
    └ reviewprofile_urlstring被评估人在该周期的个人绩效详情页链接。如果参与的项目未启动则为空
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "semester_id": "7291278856547794964",
        "reviewees": [
            {
                "reviewee_user_id": {
                    "open_id": "od-asd2dasdasd",
                    "user_id": "ou-ux987dsf6x"
                },
                "activity_ids": [
                    "7376847302857555971"
                ],
                "reviewprofile_url": "https://perf.feishu.cn/perf/profile?rootReviewId=7380183500051202067"
            }
        ],
        "has_more": true,
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
    }
}

错误码

HTTP状态码错误码描述排查建议
5001580101internal error内部错误,请稍后重试,仍然出现可以咨询客服
4001580102param is invalid请求参数错误,检查请求参数是否合法
4001580105invalid semester ID周期 ID 不存在
4001580107page token invalidpage token 不存在,请检查 page_token 入参是否正确
4001580108page token expiredpage token 已过期,请重新获取 page_token
4001580901tenant no licnese租户无绩效席位,请联系租户管理员开通绩效席位

内容来源:飞书开放平台 · 自动爬取整理