Skip to content

批量导入补充信息

批量导入被评估人的补充信息作为绩效评估的参考,如补充信息的事项、时间以及具体描述等。该接口支持创建和更新补充信息。

注意事项

该接口执行创建或者更新的判断逻辑如下(按顺序判断):

  1. 若请求参数 additional_informationsitem_ids 传入系统中已有的补充信息 ID 时,将更新对应的补充消息数据。
  2. 若请求参数 additional_informationsexternal_ids 传入系统中已有的外部系统补充信息 ID 时,将更新对应的补充消息数据。
  3. 若请求参数 additional_informationsreviewee_user_iditem time detailed_description 的参数组合在系统中已存在内容一致的补充消息时,将更新对应的补充消息数据。
  4. 以上情况都不符合时,创建新的补充消息数据。

请求

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

查询参数

名称类型必填描述
client_tokenstring根据 client_token 是否一致来判断是否为同一请求,同一请求多次调用将被拦截
示例值:12454646
数据校验规则
- 长度范围:064 字符
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
数据校验规则
- 长度范围:0999999999 字符
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
semester_idstring评估周期 ID,可通过获取周期列表接口获取
示例值:"7348736302176534547"
数据校验规则
- 长度范围:1100 字符
additional_informationsadditional_information\[\]补充信息列表
数据校验规则
- 长度范围:11000
  └ item_idstring补充信息 ID
注意:若传入系统中已有的补充信息 ID 时,将更新对应的补充消息数据
示例值:"7350194523185610771"
数据校验规则
- 长度范围:1100 字符
  └ external_idstring外部系统补充信息 ID,用于系统间的数据映射。
注意:若传入系统中已有的外部系统补充信息 ID 时,将更新对应的补充消息数据
示例值:"6789523104723558912"
数据校验规则
- 长度范围:0100 字符
  └ reviewee_user_idstring被评估人 ID 列表,与入参 user_id_type 类型一致,可通过获取被评估人信息接口获取
注意:若 reviewee_user_iditem time detailed_description 的参数组合在系统中已存在内容一致的补充消息时,将更新对应的补充消息数据
示例值:"ou_3245842393d09e9428ad4655da6e30b3"
数据校验规则
- 长度范围:19999 字符
  └ itemstring事项
注意:若 reviewee_user_iditem time detailed_description 的参数组合在系统中已存在内容一致的补充消息时,将更新对应的补充消息数据
示例值:"业绩补充说明"
数据校验规则
- 长度范围:11000 字符
  └ timestring时间
说明:文本内容,无格式校验
注意:若 reviewee_user_iditem time detailed_description 的参数组合在系统中已存在内容一致的补充消息时,将更新对应的补充消息数据
示例值:"2024-03-12"
数据校验规则
- 长度范围:1100 字符
  └ detailed_descriptionstring具体描述
注意:若 reviewee_user_iditem time detailed_description 的参数组合在系统中已存在内容一致的补充消息时,将更新对应的补充消息数据
示例值:"销售额增长目标超额完成"
数据校验规则
- 长度范围:15000 字符
import_record_namestring补充信息导入记录名称,管理员可在补充信息管理的导入记录中查看。
默认值:"API导入"
示例值:"人工导入"
数据校验规则
- 长度范围:0200 字符

请求体示例

json
{
    "semester_id": "7348736302176534547",
    "additional_informations": [
        {
            "item_id": "7350194523185610771",
            "external_id": "6789523104723558912",
            "reviewee_user_id": "ou_3245842393d09e9428ad4655da6e30b3",
            "item": "业绩补充说明",
            "time": "2024-03-12",
            "detailed_description": "销售额增长目标超额完成"
        }
    ],
    "import_record_name": "人工导入"
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ import_record_idstring导入记录 ID
  └ additional_informationsadditional_information\[\]成功导入后的补充信息列表
    └ item_idstring补充信息 ID
    └ external_idstring外部系统补充信息 ID
说明:若导入时没有提供,则返回为空
    └ reviewee_user_idstring被评估人 ID 列表,与入参 user_id_type 类型一致
    └ itemstring事项
    └ timestring时间
说明:文本内容,无格式校验
    └ detailed_descriptionstring具体描述

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
5001580101internal error请根据实际报错信息定位或咨询技术支持
4001580105semester_id is invalid周期 ID 不合法,请检查入参 semester_id 是否正确
4001580111invalid user ID被评估人 ID 不合法,请检查入参 additional_informations 中的 reviewee_user_id 是否正确
4001580110request ID repeatClient Token 重复,请检查入参 client_token 是否正确
4001580112permission denied操作无权限的被评估人数据,请检查当前应用申请的被评估人数据范围
4001580202external ID repeatExternal ID 重复,请检查入参 additional_informations 中是否有重复的 external_id
4001580203item ID repeatItem ID 重复,请检查入参 additional_informations 中是否有重复的 item_id
4001580201item ID not foundItem ID 不合法,请检查入参 additional_informations 中的 item_id是否正确
4001580204external ID is not uniqueExternal ID 已绑定在本周期其它补充信息,请检查入参 additional_informations 中的 external_id是否正确
4001580901tenant no licnese租户无绩效席位,请联系租户管理员开通绩效席位

更多错误码信息,参见通用错误码

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