# 说明
获取迭代类别默认模板字段配置
TAPD迭代支持多类别/多模板, 每一个类别和模板是一一对应关系, 且对应同一套创建页预填写字段配置。此接口可以根据项目ID和迭代类别ID获取对应的默认模板的创建页字段配置。
除了通过迭代类别ID workitem_type_id 获取配置，还可通过模板ID template_id 获取，详见 获取迭代模板字段配置。
# url
https://api.tapd.cn/iterations/default_template_fields_by_workitem_type_id
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
GET
# 请求数限制
默认返回 30 条。可通过传 limit 参数设置，最大取 200。也可以传 page 参数翻页
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| workspace_id | 是 | integer | 项目ID |
| workitem_type_id | 是 | integer | 迭代类别ID |
# 调用示例及返回结果
# 获取迭代模板字段配置
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' -d 'workspace_id=20375552&workitem_type_id=1020375553000070695' 'https://api.tapd.cn/iterations/default_template_fields_by_workitem_type_id'
# 返回结果
{
"status": 1,
"data": [
{
"WorkitemTemplateField": {
"id": "1020375553001067379",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "description",
"value": "",
"required" : "1",
"sort": "0"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067381",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "name",
"value": "",
"required" : "1",
"sort": "0"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067397",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "crucial_moment",
"value": "[{\"key\":\"StartDate\",\"name\":\"Start Date\",\"period\":\"\"},{\"key\":\"CustomMoment1\",\"name\":\"发布评审\",\"period\":\"2\"},{\"key\":\"CustomMoment2\",\"name\":\"预发布\",\"period\":\"4\"},{\"key\":\"EndDate\",\"name\":\"Start Date\",\"period\":\"6\"}]",
"required" : "0",
"sort": "0"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067397",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "jump_holiday",
"value": "1",
"required" : "0",
"sort": "0"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067387",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "custom_field_1",
"value": "",
"required" : "0",
"sort": "1"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067389",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "custom_field_2",
"value": "",
"required" : "0",
"sort": "2"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067391",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "custom_field_3",
"value": "",
"required" : "0",
"sort": "3"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067393",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "custom_field_4",
"value": "",
"required" : "0",
"sort": "4"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067395",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "custom_field_8",
"value": "",
"required" : "0",
"sort": "5"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067383",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "startdate",
"value": "",
"required" : "1",
"sort": "6"
}
},
{
"WorkitemTemplateField": {
"id": "1020375553001067385",
"workspace_id": "20375553",
"type": "iteration",
"template_id": "1020375553000077579",
"field": "enddate",
"value": "",
"required" : "1",
"sort": "7"
}
}
],
"info": "success"
}
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# 特别备注：关键日期（模板配置中 field 为 crucial_moment 和 jump_holiday 的字段）
迭代允许关联多个“关键日期”，它们代表了迭代生命周期中的一些重要时间节点。“关键日期”并非迭代的一个固有属性，但是它能作为一个字段在模板中进行整体配置。
在 创建迭代 时，若使用的workitem_type_id迭代类别对应的创建页字段中带有 field 为 crucial_moment 的字段，那么系统将会根据创建时填写的 startdate 和配置字段 value JSON配置中的节点(包括名称name; 与上一节点的间隔日期period, 配置为空则默认1天)来自动推导计算全部的关键日期。当字段配置中有 field 为 jump_holiday 且 value 为 "1" 的记录时，标记着进行自动推导计算时需要跳过节假日。
特别地，在 创建迭代 时还支持通过传递 custom_moment_{N} 的形式手动指定个别关键日期。若这样做，则该关键日期 custom_moment_{N} 不再依据前驱节点 custom_moment_{N-1} 的实际日期和预置的 period 进行推导计算，且后继节点 custom_moment_{N+1} （若它没有被手动指定）会以 custom_moment_{N} 为基点根据 period 重新计算。
← 获取迭代模板字段配置 创建任务 →