获取指定工作项的评论列表
功能介绍
获取工作项的评论
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/issues/{issue_id}/comments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
devcloud项目的32位id 最小长度：32 最大长度：32 |
|
issue_id |
是 |
Integer |
工作项id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
分页索引，偏移量 最小值：0 缺省值：0 |
|
limit |
否 |
Integer |
每页显示的条数,最大显示100条 最小值：1 最大值：100 缺省值：10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：10 最大长度：32768 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
评论总数 |
|
comments |
Array of IssueCommentV4 objects |
品论列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
comment |
String |
评论内容 |
|
id |
Integer |
评论id |
|
created_time |
String |
评论时间 |
|
timestamp |
String |
评论时间戳 |
|
user |
CommentUserV4 object |
发表评论用户信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_num_id |
Integer |
发表评论用户id |
|
user_name |
String |
发表评论用户名称 |
|
nick_name |
String |
发表评论用户昵称 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_msg |
String |
错误描述 |
|
error_code |
String |
错误码 |
请求示例
Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/issues/1232495/comments
Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/issues/1232495/comments
响应示例
状态码： 200
OK
{
"total" : 3,
"comments" : [ {
"comment" : "<p>打的费</p>",
"id" : 2777430,
"created_time" : "2019-10-18",
"timestamp" : "1684220287000",
"user" : {
"user_num_id" : 4091,
"user_name" : "demo_user_name",
"nick_name" : "name"
}
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
