批量查询补充信息

批量查询被评估人的补充信息，如补充信息的事项、时间以及具体描述等。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/performance/v2/additional_informations/query
HTTP Method	POST
接口频率限制	10 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	performance:performance 管理绩效数据 performance:performance:readonly 查看绩效数据 performance:semester_activity:read 获取周期与项目配置信息 performance:semester_activity: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"

查询参数

名称	类型	必填	描述
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
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0=
page_size	int	否	分页大小 示例值：30 默认值：20 数据校验规则： - 取值范围：0 ～ 50

请求体

名称	类型	必填	描述
semester_id	string	是	评估周期 ID，可通过获取周期列表接口获取 注意：若请求参数 item_ids、external_ids、reviewee_user_ids 均为空，返回 semester_id 参数指定周期的所有补充信息 示例值："7348736302176534547" 数据校验规则： - 长度范围：1 ～ 100 字符
item_ids	string\[\]	否	补充信息 ID 列表，可通过批量导入补充信息接口获取 说明：若提供多个筛选参数，按照 item_ids > external_ids > reviewee_user_ids 的优先级顺序，以第一个有值的筛选参数进行筛选 示例值：["7350195758357807123"] 数据校验规则： - 长度范围：0 ～ 50
external_ids	string\[\]	否	外部系统补充信息 ID 列表，该 ID 在通过批量导入补充信息接口导入时写入 说明：若提供多个筛选参数，按照 item_ids > external_ids > reviewee_user_ids 的优先级顺序，以第一个有值的筛选参数进行筛选 示例值：["6789523104723558912"] 数据校验规则： - 长度范围：0 ～ 50
reviewee_user_ids	string\[\]	否	被评估人 ID 列表，与入参 user_id_type 类型一致，可通过获取被评估人信息接口获取 说明：若提供多个筛选参数，按照 item_ids > external_ids > reviewee_user_ids 的优先级顺序，以第一个有值的筛选参数进行筛选 示例值：["ou_3245842393d09e9428ad4655da6e30b3"] 数据校验规则： - 长度范围：0 ～ 50

请求体示例

{
    "semester_id": "7348736302176534547",
    "item_ids": [
        "7350195758357807123"
    ],
    "external_ids": [
        "6789523104723558912"
    ],
    "reviewee_user_ids": [
        "ou_3245842393d09e9428ad4655da6e30b3"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ additional_informations	additional_information\[\]	补充信息列表
└ item_id	string	补充信息 ID
└ external_id	string	外部系统补充信息 ID 说明：若导入时没有提供，则返回为空
└ reviewee_user_id	string	被评估人 ID，与入参 user_id_type 类型一致
└ item	string	事项
└ time	string	时间 说明：文本内容，无格式校验
└ detailed_description	string	具体描述
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "additional_informations": [
            {
                "item_id": "7350195758357807123",
                "external_id": "6789523104723558912",
                "reviewee_user_id": "ou_3245842393d09e9428ad4655da6e30b3",
                "item": "业绩补充说明",
                "time": "2024-03-12",
                "detailed_description": "销售额增长目标超额完成"
            }
        ],
        "has_more": true,
        "page_token": "eVQrYzJBNDNONlk4VFZBZVlSdzlKdFJ4bVVHVExENDNKVHoxaVdiVnViQT0="
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1580102	param is invalid	检查参数是否正确，例如类型，大小
400	1580105	semester_id is invalid	周期 ID 不合法，请检查入参 semester_id 是否正确
500	1580101	internal error	请根据实际报错信息定位或咨询技术支持

更多错误码信息，参见通用错误码。