飞书项目帮助中心

Appearance

Return to top
页面导航

获取视图列表

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/view_conf/list
请求方式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/view_conf/list' \
--header 'X-PLUGIN-TOKEN: {{token}}' \
--header 'X-USER-KEY: {{user_key}}' \
--data-raw ''

路径参数

参数名是否必填值类型说明
project_key是string空间id [project_key]，或者空间域名 [simple_name]

请求参数

参数名是否必填值类型说明
work_item_type_key是string工作项类型
view_ids否list[string]视图id列表，查询视图id对应的视图配置，若指定视图id，其余筛选条件不会起作用。
created_by否string可根据该字段筛选，筛选出指定用户创建的视图
created_at否TimeInterval可以根据该字段筛选，筛选出创建时间在该时间区间的视图配置信息
page_size否int64每页数据，最大 200
page_num否int64分页页码，从 1 开始，默认为1。

返回值类型

list[ViewConf]

返回格式 

{
     "pagination": {
        "page_num": 1,
        "page_size": 2,
        "total": 23
    },
    "data": [
        {
            "auth": 2, //Open = 1 //开放权限打开  Close = 2 //开放权限关闭 
            "collaborators": [], //协作者
            "created_at": 1625538378124, //创建时间时间戳
            "created_by": "", //创建者
            "name": "待评审需求池", //视图名称
            "system_view": 1, //是否系统视图 True = 1 //系统视图 False = 2 //不是系统视图
            "view_id": "55shx6knRM", //视图id
            "view_type": 0, //视图类型 Unknow = 0 Condition = 1 //条件视图 Fixed = 2 //固定视图
            "view_url": "https://XXX.feishu.cn/zjq-test/storyView/55shx6knRM" //视图链接
        },
        {
            "auth": 2,
            "collaborators": [],
            "created_at": 1625538378124,
            "created_by": "",
            "name": "上线需求池",
            "system_view": 1,
            "view_id": "55s2bezng",
            "view_type": 0,
            "view_url": "https://XXX.feishu.cn/zjq-test/storyView/55s2bezng"
        }
    ],
    "err": {},
    "err_code": 0,
    "err_msg": ""
}