# 说明
返回符合查询条件的所有需求分类(分页显示,默认一页30条)
# url
https://api.tapd.cn/story_categories
# 支持格式
JSON/XML(默认JSON格式)
# HTTP请求方式
GET
# 请求数限制
默认返回 30 条。可通过传 limit 参数设置,最大取 200。也可以传 page 参数翻页
# 请求参数
字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
---|---|---|---|---|
id | 否 | integer | id | 支持多ID查询 |
workspace_id | 是 | integer | 项目ID | |
name | 否 | string | 需求分类名称 | 支持模糊匹配 |
description | 否 | string | 需求分类描述 | |
parent_id | 否 | integer | 父分类ID | |
created | 否 | datetime | 创建时间 | 支持时间查询 |
modified | 否 | datetime | 最后修改时间 | 支持时间查询 |
limit | 否 | integer | 设置返回数量限制,默认为30 | |
page | 否 | integer | 返回当前数量限制下第N页的数据,默认为1(第一页) | |
order | 否 | string | 排序规则,规则:字段名 ASC或者DESC,然后 urlencode | 如按创建时间逆序:order=created%20desc |
fields | 否 | string | 设置获取的字段,多个字段间以','逗号隔开 |
# 调用示例及返回结果
# 获取项目下需求分类
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/story_categories?workspace_id=10158231'
# 返回结果
{
"status": 1,
"data": [
{
"Category": {
"id": "1010158231000077719",
"workspace_id": "10158231",
"name": "None Category",
"description": "未分类",
"parent_id": "0",
"created": "2017-06-20 16:55:56",
"modified": "2017-06-20 16:55:56"
}
},
{
"Category": {
"id": "1010158231000077717",
"workspace_id": "10158231",
"name": "优化需求",
"description": "优化需求",
"parent_id": "1010158231000077711",
"created": "2017-06-20 16:48:59",
"modified": "2017-06-20 16:48:59"
}
},
{
"Category": {
"id": "1010158231000077715",
"workspace_id": "10158231",
"name": "新功能",
"description": "新功能",
"parent_id": "1010158231000077711",
"created": "2017-06-20 16:48:59",
"modified": "2017-06-20 16:48:59"
}
},
{
"Category": {
"id": "1010158231000077713",
"workspace_id": "10158231",
"name": "技术需求",
"description": "技术需求",
"parent_id": "0",
"created": "2017-06-20 16:48:59",
"modified": "2017-06-20 16:48:59"
}
},
{
"Category": {
"id": "1010158231000077711",
"workspace_id": "10158231",
"name": "产品需求",
"description": "产品需求",
"parent_id": "0",
"created": "2017-06-20 16:48:59",
"modified": "2017-06-20 16:48:59"
}
}
],
"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
52
53
54
55
56
57
58
59
60
61
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
52
53
54
55
56
57
58
59
60
61
# 需求分类字段说明
# 需求分类重要字段说明
字段 | 说明 |
---|---|
id | id |
workspace_id | 项目ID |
name | 需求分类名称 |
description | 需求分类描述 |
parent_id | 父分类ID |
created | 创建时间 |
modified | 最后修改时间 |