# 说明
获取工作项自定义字段配置
# url
https://api.tapd.cn/mini_items/custom_fields_settings
# 支持格式
JSON/XML（默认JSON格式）
# HTTP请求方式
GET
# 请求数限制
一次只能获取一个空间的配置
# 请求参数
| 字段名 | 必选 | 类型及范围 | 说明 | 特殊规则 |
|---|---|---|---|---|
| workspace_id | 是 | integer | 空间ID |
# 调用示例及返回结果
# 获取工作项自定义字段配置
# curl 使用 Basic Auth 鉴权调用示例
curl -u 'api_user:api_password' 'https://api.tapd.cn/mini_items/custom_fields_settings?workspace_id=69993260'
# curl 使用 OAuth Access Token 鉴权调用示例
curl -H 'Authorization: Bearer ACCESS_TOKEN' 'https://api.tapd.cn/mini_items/custom_fields_settings?workspace_id=69993260'
# 返回结果
{
"status": 1,
"data": [
{
"CustomFieldConfig": {
"id": "1069993260215045623",
"workspace_id": "69993260",
"entry_type": "mini_item",
"custom_field": "custom_field_one",
"type": "file",
"name": "图片与文件",
"options": "{}",
"extra_config": null,
"enabled": "1",
"freeze": "0",
"sort": "0",
"memo": ""
}
},
{
"CustomFieldConfig": {
"id": "1069993260215046499",
"workspace_id": "69993260",
"entry_type": "mini_item",
"custom_field": "custom_field_four",
"type": "user_chooser",
"name": "开发人员",
"options": "{}",
"extra_config": null,
"enabled": "1",
"freeze": "0",
"sort": "0",
"memo": ""
}
},
{
"CustomFieldConfig": {
"id": "1069993260215046895",
"workspace_id": "69993260",
"entry_type": "mini_item",
"custom_field": "custom_field_six",
"type": "user_chooser",
"name": "测试人员",
"options": "{}",
"extra_config": null,
"enabled": "1",
"freeze": "0",
"sort": "0",
"memo": ""
}
},
{
"CustomFieldConfig": {
"id": "1069993260215048539",
"workspace_id": "69993260",
"entry_type": "mini_item",
"custom_field": "custom_field_9",
"type": "datetime",
"name": "测试时间",
"options": "{}",
"extra_config": null,
"enabled": "1",
"freeze": "0",
"sort": "0",
"memo": ""
}
},
{
"CustomFieldConfig": {
"id": "1069993260215049365",
"workspace_id": "69993260",
"entry_type": "mini_item",
"custom_field": "custom_field_10",
"type": "user_chooser",
"name": "测试人",
"options": "{}",
"extra_config": null,
"enabled": "1",
"freeze": "0",
"sort": "0",
"memo": ""
}
}
],
"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
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
# 返回字段说明
| 字段 | 说明 |
|---|---|
| id | 自定义字段配置的ID |
| workspace_id | 所属空间ID |
| entry_type | 工作项ID |
| custom_field | 自定义字段标识（英文名） |
| type | 输入类型 |
| name | 自定义字段显示名称 |
| options | 自定义字段可选值 |
| enabled | 是否启用 |
| sort | 显示时排序系数 |
| freeze | 是否冻结 |
| extra_config | 额外配置 |