获取工作项的评论V2
功能介绍
获取工作项的评论V2。
调用方法
请参见如何调用API。
URI
GET /v2/issues/get-comments
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 分页索引,偏移量,offset是limit的整数倍数。例如,offset为0表示从第一个记录开始,offset为10表示从第11个记录开始。 约束限制: 不涉及。 取值范围: 最小值:0,最大值:10000。 默认取值: 缺省值:0。 |
|
limit |
否 |
Integer |
参数解释: 条数,每页显示查询的数量。 约束限制: 不涉及。 取值范围: 最小长度:1,最大长度:10。 默认取值: 10。 |
|
project_uuid |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
type |
是 |
String |
参数解释: 项目类型。 约束限制: 不涉及。 取值范围: "scrum"。 默认取值: 不涉及。 |
|
issue_id |
是 |
Integer |
参数解释: 工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
result object |
参数解释: 查询工作项的评论结果。 |
|
status |
String |
参数解释: 返回状态。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
comments |
Array of comments objects |
参数解释: 工作项的评论列表。 |
|
journals_total |
Integer |
参数解释: 评论总条数。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释: 评论信息的id。 取值范围: 不涉及。 |
|
notes |
String |
参数解释: 工作项的评论内容。 取值范围: 不涉及。 |
|
created_on |
String |
参数解释: 评论的创建时间时间戳(示例:1754361449000) 取值范围: 不涉及。 |
|
user |
IssueUserVO object |
参数解释: 发表评论的用户信息。 取值范围: 不涉及。 |
请求示例
GET https://{endpoint}/v2/issues/get-comments?issue_id=9182484&project_uuId=af2d9ea776204a4395e238dd156b2ca9&limit=10&offset=0&type=scrum&_=1753348089805
响应示例
状态码:200
获取工作项的评论接口成功的响应。
{
"result" : {
"comments" : [ {
"id" : 11260742,
"notes" : "<p>正处在此次</p>",
"created_on" : "1753348089000",
"user" : {
"id" : 1111,
"name" : "xxxxxx",
"first_name" : "xxxxxx",
"nick_name" : "xxxxxx",
"image_id" : "photo01.png",
"identifier" : "xxxxxx"
}
}, {
"id" : 11260741,
"notes" : "<p>安心</p>",
"created_on" : "1753348085000",
"user" : {
"id" : 1111,
"name" : "xxxxxx",
"first_name" : "xxxxxx",
"nick_name" : "xxxxxx",
"image_id" : "photo01.png",
"identifier" : "xxxxxx"
}
} ],
"journals_total" : 2
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取工作项的评论接口成功的响应。 |
错误码
请参见错误码。