Skip to content

更新固定视图

请求体说明

类别
请求地址{base_url}/open_api/:project_key/:work_item_type_key/fix_view/:view_id
请求方式POST

请求 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_type_key/fix_view/:view_id' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

参数名是否必填值类型说明
project_keystring空间id [project_key],或者空间域名 [simple_name]
work_item_type_keystring工作项类型,可以从 获取工作项类型 接口获取
view_idstring视图ID

请求参数

参数名是否必填值类型说明
add_work_item_idslist[int64]待添加的工作项ID列表,目前仅支持全部为需求/缺陷
remove_work_item_idslist[int64]待添加的工作项ID列表,目前仅支持全部为需求/缺陷

请求体格式

{
    "remove_work_item_ids":[
        3847846
    ]
}

返回值类型

FixView

返回格式

{
    "data": {//结构同创建视图
        "created_at": 1639983457330,
        "created_by": "701251455518xxxxx",
        "editable": false,
        "modified_by": "701251455518xxxxx",
        "name": "视图",
        "view_id": "Pb1F12TzR",
        "work_item_id_list": [
            1746046,
            1746045,
            1744768
        ]
    },
    "pagination": {
        "page_num": 1,
        "page_size": 200,
        "total": 3
    },
    "err": {},
    "err_msg": "",
    "err_code": 0
}