飞书项目帮助中心

Appearance

Return to top
页面导航

查询评论

请求体说明

类别值
请求地址{base_url}/open_api/:project_key/work_item/:work_item_type_key/:work_item_id/comments?page_size=:page_size&page_num=:page_num
请求方式GET

请求 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/comment/create' \
--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工作项类型，可以从获取工作项类型接口获取
work_item_id是int64工作项ID
comment_id是int64评论id

请求体参数

参数名是否必填值类型说明
page_size否int64每页数据，最大 200。
page_num否int64分页页码，从1开始，默认为1。

返回值类型

list[Comment]

返回格式 

{
    "data":[{
        "id": 1,//评论id
        "work_item_id": 1,//工作项id
        "work_item_type_key": "issue",//工作项类型
        "created_at": 1639983457330,//创建时间，毫秒精度
        "operator": "35432532xxxx",//评论者
        "content": "评论内容"//评论内容
    }],
    "pagination": {
        "page_num": 1,
        "page_size": 200,
        "total": 1
    },
    "err": {},
    "err_msg": "",
    "err_code": 0
}