批量更新指标项

PATCH

https://open.feishu.cn/open-apis/okr/v1/metric_sources/{metric_source_id}/tables/{metric_table_id}/items/batch_update

该接口用于批量更新多项指标，单次调用最多更新 100 条记录。接口仅限 OKR 企业版使用。

更新成功后 OKR 系统会给以下人员发送消息通知：

首次更新目标值的人员

已经将指标添加为 KR、且本次目标值/起始值/支撑的上级有变更的人员，不包含仅更新了进度值的人员

错误码

HTTP状态码	错误码	描述	排查建议
500	1009999	Unknown error. Please contact Feishu Assistant or your customer success manager.	内部错误，请联系飞书助手或您的客户成功经理
500	1009998	system exception	系统异常
200	1001001	Invalid parameters. Please check document and modify accordingly.	无效的参数，请对照文档检查输入的参数
200	1001002	No permission.	您无权访问该接口，请确认您的登录凭证
200	1001003	User not found.	用户不存在
200	1001004	OKR data not found.	对应ID的数据不存在
400	1001005	update numbers exceeds limit	更新数量超过限制
400	1001006	start value equals target value	起始值等于目标值
400	1001007	table id match error	表的 id 匹配错误
403	1000403	OpenAPI is unavailable in current edition (Standard edition). Please update to Business edition.	您目前的套餐无法使用开放平台接口功能，请升级至OKR企业版

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://open.feishu.cn/open-apis/okr/v1/metric_sources/7041857032248410131/tables/7041857032248410131/items/batch_update?user_id_type=' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "items": [
        {
            "metric_item_id": "635782378412311",
            "metric_initial_value": 1.0,
            "metric_target_value": 3.0,
            "metric_current_value": 2.0,
            "supported_user_id": "7041857032248410131"
        }
    ]
}'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "items": [
            {
                "metric_item_id": "635782378412311",
                "user_id": "635782378412311",
                "period_id": "635782378412311",
                "metric_unit": {
                    "zh_cn": "小明",
                    "en_us": "jack",
                    "ja_jp": "シャオ・ミン"
                },
                "metric_initial_value": 10.01,
                "metric_target_value": 10.01,
                "metric_current_value": 10.01,
                "supported_user_id": "ou_8e7d79ca2327bf4f0b3c37899d6abbd5",
                "kr_id": "7139040982003302420",
                "updated_at": "1663145941129",
                "updated_by": "ou_8e7d79ca2327bf4f0b3c37899d6abbd5"
            }
        ],
        "failed_items": [
            {
                "metric_item_id": "7139040982003302420",
                "reason": "start value equals target value"
            }
        ]
    }
}

请求参数

Path 参数

metric_source_id

string

必需

okr指标库id

示例值:

7041857032248410131

metric_table_id

string

必需

okr指标表id

示例值:

7041857032248410131

Query 参数

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，字段权限要求：

获取用户 user ID

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

items

array [object {5}]

指标列表

必需

metric_item_id

string

必需

指标表id 示例值："635782378412311"

metric_initial_value

integer

可选

指标起始值示例值：1.0

metric_target_value

integer

可选

指标目标值示例值：3.0

metric_current_value

integer

可选

指标进度值示例值：2.0

supported_user_id

string

可选

指标支撑的上级人员 id 示例值："7041857032248410131"

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {11}]

指标项列表

必需

failed_items

array [object {2}]

更新失败列表

必需

修改于 2023-02-07 07:46:03

更新指标项

获取指标项

批量更新指标项

错误码#

请求参数

返回响应

错误码