# 说明
返回符合查询条件的所有评论（分页显示，默认一页30条）
# url
https://api.tapd.cn/comments
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
GET
# 请求数限制
默认返回 30 条。可通过传 limit 参数设置，最大取 200。也可以传 page 参数翻页
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
|---|---|---|---|---|
| id | 否 | integer | 评论ID | 支持多ID查询 |
| title | 否 | string | 标题 | |
| description | 否 | string | 内容 | |
| author | 否 | string | 评论人 | |
| entry_id | 否 | integer | 评论所属工作项id | |
| created | 否 | datetime | 创建时间 | 支持时间查询 |
| modified | 否 | datetime | 最后更改时间 | 支持时间查询 |
| workspace_id | 是 | integer | 空间ID | |
| root_id | 否 | integer | 根评论ID | |
| reply_id | 否 | integer | 评论回复的ID | |
| limit | 否 | integer | 设置返回数量限制，默认为30 | |
| page | 否 | integer | 返回当前数量限制下第N页的数据，默认为1（第一页） | |
| order | 否 | string | 排序规则，规则：字段名 ASC或者DESC，然后 urlencode | 如按创建时间逆序：order=created%20desc |
| fields | 否 | string | 设置获取的字段，多个字段间以','逗号隔开 |
# 调用示例及返回结果
# 获取空间下评论
# curl 调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/comments?workspace_id=69993260'
# curl 使用 OAuth Access Token 鉴权调用示例
curl -H 'Authorization: Bearer ACCESS_TOKEN' 'https://api.tapd.cn/comments?workspace_id=69993260'
# 返回结果
{
"status": 1,
"data": [
{
"Comment": {
"id": "1069993260058859425",
"title": "在状态 [未开始] 添加",
"description": "<p>test1</p>",
"author": "orangecyang",
"entry_type": "mini_items",
"entry_id": "1069993260855484441",
"reply_id": "0",
"root_id": "0",
"created": "2023-03-16 14:19:34",
"modified": "2023-03-16 14:19:34",
"workspace_id": "69993260"
}
},
{
"Comment": {
"id": "1069993260058848877",
"title": "在状态 [未开始] 添加",
"description": "<p>test2</p>",
"author": "orangecyang",
"entry_type": "mini_items",
"entry_id": "1069993260855310177",
"reply_id": "0",
"root_id": "0",
"created": "2023-01-13 15:29:24",
"modified": "2023-01-13 15:29:24",
"workspace_id": "69993260"
}
},
{
"Comment": {
"id": "1069993260058848801",
"title": "在状态 [未开始] 添加",
"description": "<p>test3</p>",
"author": "orangecyang",
"entry_type": "mini_items",
"entry_id": "1069993260855310179",
"reply_id": "0",
"root_id": "0",
"created": "2023-01-13 14:44:04",
"modified": "2023-01-13 14:44:04",
"workspace_id": "69993260"
}
}
],
"info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# 获取某条工作项的评论
# curl 调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/comments?entry_id=1069993260856110919&limit=2&workspace_id=69993260'
# curl 使用 OAuth Access Token 鉴权调用示例
curl -H 'Authorization: Bearer ACCESS_TOKEN' 'https://api.tapd.cn/comments?entry_id=1069993260856110919&limit=2&workspace_id=69993260'
# 返回结果
{
"status": 1,
"data": [
{
"Comment": {
"id": "1069993260059089547",
"title": "在状态 [已完成] 添加",
"description": "<p>测试一下</p>",
"author": "orangecyang",
"entry_type": "mini_items",
"entry_id": "1069993260856110919",
"reply_id": "0",
"root_id": "0",
"created": "2023-07-18 21:39:34",
"modified": "2023-07-18 21:39:34",
"workspace_id": "69993260"
}
}
],
"info": "success"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# 评论字段说明
# 评论重要字段说明
| 字段 | 说明 |
|---|---|
| id | 评论ID |
| title | 标题 |
| description | 内容 |
| author | 评论人 |
| entry_type | 评论类型 |
| entry_id | 评论所属工作项id |
| created | 创建时间 |
| modified | 最后更改时间 |
| workspace_id | 空间ID |
| root_id | 根评论ID |
| reply_id | 评论回复的ID |