# 说明
获取需求所有字段及候选值，返回符合查询条件的所有需求字段及候选值。 部分字段为静态候选值，建议参考下方 “可选值说明”部分。其余动态字段（如：status(状态)/iteration_id(迭代)/categories(需求分类)），需要通过该接口获取对应的候选值（中英文映射）。
# url
https://api.tapd.cn/stories/get_fields_info
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
GET
# 请求数限制
默认返回所有数据
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
|---|---|---|---|---|
| workspace_id | 是 | integer | 项目ID |
# 调用示例及返回结果
# 获取项目下的需求字段
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/stories/get_fields_info?workspace_id=10104801'
# 返回结果
{
"status": 1,
"data": {
"id": {
"name": "id",
"options": [],
"html_type": "input",
"label": "ID"
},
"name": {
"name": "name",
"options": [],
"html_type": "input",
"label": "标题"
},
"status": {
"name": "status",
"options": {
"planning": "规划中",
"developing": "实现中",
"resolved": "已实现",
"rejected": "已拒绝",
"status_1": "其他状态1",
"status_5": "new"
},
"html_type": "select",
"label": "状态"
},
"description": {
"name": "description",
"options": [],
"html_type": "rich_edit",
"label": "详细描述"
},
"owner": {
"name": "owner",
"options": [],
"html_type": "user_chooser",
"label": "处理人"
},
"creator": {
"name": "creator",
"options": [],
"html_type": "user_chooser",
"label": "创建人"
},
"created": {
"name": "created",
"options": [],
"html_type": "datetime",
"label": "创建时间"
},
"iteration_id": {
"name": "iteration_id",
"options": {
"1010104801001248517": "adra",
"1010104801001179909": "aaaassssss",
"1010104801001179887": "cjdd",
"1010104801001171067": "oyctest20190911xxx1111",
"1010104801001169803": "oyctest20190911xxx1111",
"1010104801001123313": "oyctest20190911",
"1010104801001123207": "oyctest20190911",
"1010104801001112221": "myI",
"1010104801001105965": "oyctest20190911xxx1111",
"1010104801001105193": "oyctest20190911xxx1111",
"1010104801001103985": "对对对",
"1010104801001082081": "oyctest20190911",
"1010104801001082017": "日常发布",
"1010104801001082013": "日常发布",
"1010104801001081899": "oyctest20190917ABC2",
"1010104801001080913": "【Word】191001常规发布",
"1010104801001080783": "日常发布",
"1010104801000648821": "ssss",
"1010104801000507691": "i2",
"1010104801000507689": "i1",
"1010104801000423181": "迭代1"
},
"html_type": "select",
"label": "迭代"
},
"effort": {
"name": "effort",
"options": [],
"html_type": "input",
"label": "预估工时"
},
"effort_completed": {
"name": "effort_completed",
"options": [],
"html_type": "input",
"label": "完成工时"
},
"remain": {
"name": "remain",
"options": [],
"html_type": "input",
"label": "剩余工时"
},
"exceed": {
"name": "exceed",
"options": [],
"html_type": "input",
"label": "超出工时"
},
"progress": {
"name": "progress",
"options": [],
"html_type": "input",
"label": "进度"
},
"modified": {
"name": "modified",
"options": [],
"html_type": "datetime",
"label": "最后修改时间"
},
"priority": {
"name": "priority",
"options": {
"4": "High",
"3": "Middle",
"2": "Low",
"1": "Nice To Have"
},
"html_type": "select",
"label": "优先级"
},
"cc": {
"name": "cc",
"options": [],
"html_type": "mix_chooser",
"label": "抄送人"
},
"begin": {
"name": "begin",
"options": [],
"html_type": "dateinput",
"label": "预计开始"
},
"due": {
"name": "due",
"options": [],
"html_type": "dateinput",
"label": "预计结束"
},
"source": {
"name": "source",
"options": {
"产品规划": "产品规划",
"用户反馈": "用户反馈",
"总办": "总办",
"其他": "其他",
"CE平台": "CE平台"
},
"html_type": "select",
"label": "需求来源"
},
"workitem_type_id": {
"name": "workitem_type_id",
"label": "需求类别",
"options": {
"1010104801000022091": "需求",
"1010104801000078307": "技术需求aaa"
},
"html_type": "select"
},
"type": {
"name": "type",
"options": {
"功能需求": "功能需求",
"体验优化需求": "体验优化需求",
"技术需求": "技术需求",
"其他": "其他"
},
"html_type": "select",
"label": "需求类型"
},
"children_id": {
"name": "children_id",
"options": [],
"html_type": "input",
"label": "子需求"
},
"completed": {
"name": "completed",
"options": [],
"html_type": "datetime",
"label": "完成时间"
},
"parent_id": {
"name": "parent_id",
"options": [],
"html_type": "input",
"label": "父需求"
},
"business_value": {
"name": "business_value",
"options": [],
"html_type": "input",
"label": "业务价值"
},
"tech_risk": {
"name": "tech_risk",
"options": [],
"html_type": "input",
"label": "技术风险"
},
"size": {
"name": "size",
"options": [],
"html_type": "input",
"label": "规模"
},
"feature": {
"name": "feature",
"options": {
"tx1": "tx1"
},
"html_type": "select",
"label": "特性"
},
"test_focus": {
"name": "test_focus",
"options": [],
"html_type": "textarea",
"label": "测试重点"
},
"developer": {
"name": "developer",
"options": [],
"html_type": "user_chooser",
"label": "开发人员"
},
"category_id": {
"name": "category_id",
"options": {
"1010104801000037409": "abc",
"1010104801000037411": "adfadxx",
"1010104801001049673": "test",
"1010104801001179311": "ttt",
"1010104801001228145": "abc",
"-1": "未分类"
},
"html_type": "select",
"label": "需求分类"
},
"confidential": {
"name": "confidential",
"options": {
"Y": "是",
"N": "否"
},
"html_type": "select",
"label": "保密"
},
"module": {
"name": "module",
"options": {
"222": "222",
"创建模块": "创建模块"
},
"html_type": "select",
"label": "模块"
},
"release_id": {
"name": "release_id",
"options": {
"1010104801000069739": "v2test",
"1010104801000068721": "test",
"1010104801000068405": "发布",
"1010104801000058771": "4324"
},
"html_type": "select",
"label": "发布计划"
},
"version": {
"name": "version",
"options": {
"测试": "测试"
},
"html_type": "select",
"label": "版本"
},
"custom_field_50": {
"name": "custom_field_50",
"label": "客户联系方式",
"memo": "提供客户联系方式： QQ号+手机号+UIN",
"options": [],
"html_type": "text"
},
"custom_field_49": {
"name": "custom_field_49",
"label": "反馈量（一线）",
"memo": "",
"options": [],
"html_type": "text"
},
"custom_field_48": {
"name": "custom_field_48",
"label": "产品分类",
"memo": "",
"options": {
"C": "C",
"d": "d",
},
"html_type": "select"
},
"custom_field_one": {
"name": "custom_field_one",
"label": "atime",
"memo": "",
"options": [],
"html_type": "dateinput"
},
"custom_field_two": {
"name": "custom_field_two",
"label": "测试字段1",
"memo": "",
"options": {
"1": "1",
"2": "2",
"3": "3"
},
"html_type": "checkbox"
}
},
"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
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# 返回说明
# 格式说明
| 字段 | 说明 |
|---|---|
| name | name |
| options | 候选值 |
| html_type | 类型 |
| label | 中文名称 |
# 返回字段说明
| 字段 | 说明 |
|---|---|
| id | ID |
| name | 标题 |
| priority | 优先级 |
| business_value | 业务价值 |
| status | 状态 |
| version | 版本 |
| module | 模块 |
| feature | 特性 |
| test_focus | 测试重点 |
| size | 规模 |
| owner | 处理人 |
| cc | 抄送人 |
| creator | 创建人 |
| developer | 开发人员 |
| begin | 预计开始 |
| due | 预计结束 |
| created | 创建时间 |
| modified | 最后修改时间 |
| completed | 完成时间 |
| iteration_id | 迭代ID |
| templated_id | 模板ID |
| effort | 预估工时 |
| effort_completed | 完成工时 |
| remain | 剩余工时 |
| exceed | 超出工时 |
| category_id | 需求分类(取 -1 时，为未分类) |
| release_id | 发布计划 |
| is_archived | 是否归档 |
| source | 来源 |
| type | 类型 |
| parent_id | 父需求 |
| children_id | 子需求 |
| description | 详细描述 |
| workspace_id | 项目ID |
| workitem_type_id | 需求类别 |
| confidential | 是否保密 |
| created_from | 需求创建来源（为空时代表web创建） |
| level | 层级 |
| bug_id | 缺陷ID（当缺陷转需求时才会有值） |
# 可选值说明
- 需求优先级(priority)取值字段说明 |取值|字面值| |:----😐:----😐 | 4 | High | | 3 | Middle | | 2 | Low | | 1 | Nice To Have |