# 说明
返回项目下的工作流列表(分页显示,默认一页30条)
# url
https://api.tapd.cn/workflows
# 支持格式
JSON/XML(默认JSON格式)
# HTTP请求方式
GET
# 请求数限制
默认返回 30 条。可通过传 limit 参数设置,最大取 200。也可以传 page 参数翻页
# 请求参数
字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
---|---|---|---|---|
id | 否 | integer | id | |
name | 否 | string | 标题 | |
description | 否 | string | 详细描述 | |
system_name | 否 | string | 系统名。取 bugtrace (缺陷的)或者 story(需求的) | |
creator | 否 | string | 创建人 | |
created | 否 | datetime | 创建时间 | |
workspace_id | 是 | integer | 项目ID | |
limit | 否 | integer | 设置返回数量限制,默认为30 | |
page | 否 | integer | 返回当前数量限制下第N页的数据,默认为1(第一页) | |
fields | 否 | string | 设置获取的字段,多个字段间以','逗号隔开 |
# 调用示例及返回结果
# 获取项目下的模块信息
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/workflows?workspace_id=10104801'
curl 'https://api.tapd.cn/workflows?workspace_id=10104801&access_token=ACCESS_TOKEN'
# 返回结果
{
"status": 1,
"data": [
{
"Workflow": {
"id": "1010104801000128627",
"workspace_id": "10104801",
"name": "bbb",
"description": "",
"system_name": "story",
"is_default": "0",
"created": "2021-01-26 16:42:33",
"creator": "anyechen",
"modified": "2021-01-26 16:43:28",
"modifier": "anyechen"
}
},
{
"Workflow": {
"id": "1010104801000050043",
"workspace_id": "10104801",
"name": "system workflow",
"description": "系统默认工作流",
"system_name": "story",
"is_default": "1",
"created": "2017-08-10 10:17:45",
"creator": "",
"modified": "2020-11-27 06:13:13",
"modifier": "v_xuanfang"
}
},
{
"Workflow": {
"id": "1010104801000050003",
"workspace_id": "10104801",
"name": "system workflow",
"description": "111\"&gt;</textarea>",
"system_name": "bugtrace",
"is_default": "1",
"created": "2017-06-30 15:54:38",
"creator": "v_xuanfang",
"modified": "2020-11-27 06:13:11",
"modifier": "v_xuanfang"
}
}
],
"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
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
# 模块字段说明
# 模块重要字段说明
字段 | 说明 |
---|---|
id | id |
name | 标题 |
description | 详细描述 |
system_name | 应用类型 |
is_default | 是否默认 |
modifier | 最后修改人 |
modified | 最后修改时间 |
creator | 创建人 |
created | 创建时间 |
workspace_id | 项目ID |