飞书项目帮助中心

Appearance

Return to top
页面导航

更新工作项

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id
请求方式PUT

请求 Header

字段值必须填写
Content-Typeapplication/json必须
X-PLUGIN-TOKEN用户在开放平台中获取的 Token，参考插件身份凭证章节。必须
X-USER-KEY当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取可选
X-IDEM-UUID写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断可选

参考请求格式如下：

curl --location -g --request GET '{base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

参数名是否必填值类型说明
project_key是string空间id [project_key]，或者空间域名 [simple_name]
work_item_id是int64工作项ID
work_item_type_key是string工作项类型，可以从获取工作项类型接口获取。

请求参数

参数名是否必填值类型说明
update_fields是list[FieldValuePair]要更新的字段列表，字段格式可查看字段格式对应表。

请求体格式 

{
    "update_fields":[
        {
            "field_key":"field_184c63",
            "field_value":1646409600000
        }，
        {
            "field_key": "role_owners",
            "field_value":[
                {
                   "role":"rd",
                   "owners":["testuser"]//user_key列表
                }
            ]
        }
    ]
}

返回格式 

{
    "err": {},
    "err_msg": "",
    "err_code": 0
}

请注意以下事项

工作项的以下字段不可更新： _id，created_by，created_at，updated_by，updated_at，aborted，all_states，deleted， node_schedules，states，state_times，sub_stage_times，template_version， wfState，last_update_time，work_item_type_key

目前暂不支持的字段类型： 富文本（不支持多格式），投票，附件，多值系统外信号