# 说明
创建迭代，返回创建迭代的数据
# url
https://api.tapd.cn/iterations
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
POST
# 请求数限制
一次插入一条数据
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| name | 是 | string | 标题 |
| workspace_id | 是 | integer | 项目ID |
| startdate | 是 | date | 开始时间 |
| enddate | 是 | date | 结束时间 |
| creator | 是 | string | 创建人 |
| workitem_type_id | 否 | integer | 迭代类别id，类别列表可以从 获取迭代类别列表 获取 |
| plan_app_id | 否 | integer | 计划应用ID |
| entity_type | 否 | string | 默认为'iteration'. 选择创建的是'iteration'(迭代)还是'release'(迭代的上层计划). |
| parent_id | 否 | integer | 默认为0. 指定当前迭代的上层计划, 只能指定'release'为'iteration'的上层计划. |
| description | 否 | string | 详细描述 |
| status | 否 | string | 状态 |
| label | 否 | string | 标签，标签不存在时将自动创建，多个以英文坚线分格 |
| cus_{$自定义字段别名} | 否 | string | 自定义字段值，参数名会由后台自动转义为custom_field_*，如：cus_自定义字段的名称 |
| custom_field_* | 否 | string或者integer | 自定义字段参数，具体字段名通过接口 获取迭代自定义字段配置 获取 |
| custom_moment_* | 否 | string | 手动指定关键日期，具体需要根据 获取迭代模板字段配置 的 crucial_moment 字段配置确定 |
# 调用示例及返回结果
# 在项目下创建迭代
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' -d 'name=test&startdate=2020-06-05&enddate=2020-06-15&workspace_id=10104801&creator=v_xuanfang&cus_自定义字段的名称=custom_field_value' 'https://api.tapd.cn/iterations'
# 返回结果
{
"status": 1,
"data": {
"Iteration": {
"id": "1010104801001171471",
"name": "test",
"workspace_id": "10104801",
"startdate": "2020-06-05",
"enddate": "2020-06-15",
"status": "open",
"release_id": null,
"description": null,
"creator": "v_xuanfang",
"created": "2020-06-05 16:11:53",
"modified": "2020-06-05 16:11:53",
"completed": null,
"entity_type": "iteration",
"parent_id": 0,
"cus_自定义字段的名称": "custom_field_value",
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"custom_field_5": null,
"custom_field_6": null,
"custom_field_7": null,
"custom_field_8": null,
"custom_field_9": null,
"custom_field_10": null,
"custom_field_11": null,
"custom_field_12": null,
"custom_field_13": null,
"custom_field_14": null,
"custom_field_15": null,
"custom_field_16": null,
"custom_field_17": null,
"custom_field_18": null,
"custom_field_19": null,
"custom_field_20": null,
"custom_field_21": null,
"custom_field_22": null,
"custom_field_23": null,
"custom_field_24": null,
"custom_field_25": null,
"custom_field_26": null,
"custom_field_27": null,
"custom_field_28": null,
"custom_field_29": null,
"custom_field_30": null,
"custom_field_31": null,
"custom_field_32": null,
"custom_field_33": null,
"custom_field_34": null,
"custom_field_35": null,
"custom_field_36": null,
"custom_field_37": null,
"custom_field_38": null,
"custom_field_39": null,
"custom_field_40": null,
"custom_field_41": null,
"custom_field_42": null,
"custom_field_43": null,
"custom_field_44": null,
"custom_field_45": null,
"custom_field_46": null,
"custom_field_47": null,
"custom_field_48": null,
"custom_field_49": null,
"custom_field_50": null
}
},
"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
62
63
64
65
66
67
68
69
70
71
72
73
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
62
63
64
65
66
67
68
69
70
71
72
73
# 迭代字段说明
# 迭代重要字段说明
| 字段 | 说明 |
|---|---|
| id | ID |
| name | 标题 |
| workspace_id | 项目ID |
| description | 详细描述 |
| startdate | 开始时间 |
| enddate | 结束时间 |
| status | 状态 |
| creator | 创建人 |
| created | 创建时间 |
| modified | 最后修改时间 |
| completed | 完成时间 |
| entity_type | 创建的是'iteration'还是'release' |
| parent_id | 创建的'iteration'所指定的上层计划ID(这个上层计划必须是'release') |
| workitem_type_id | 迭代类别 |
# 迭代状态(status)字段说明
| 字段值 | 状态名 |
|---|---|
| open | 开启 |
| done | 已关闭 |
← 更新系统字段 获取迭代自定义字段配置 →