1.1. 获取自定义字段
企业可通过此接口获取相关对象的自定义字段
1.1.1. 请求方法
POST /customField/list
1.1.2. 请求参数
| 参数名 |
必填 |
类型 |
说明 |
| type |
是 |
Integer |
业务类型，66:企业, 100：客户，101：客户群，103:商机, 110：员工, 122:订单 |
1.1.3. 返回数据
| 属性名 |
类型 |
说明 |
| code |
整型 |
执行结果码，200表示成功，其他表示错误 |
| message |
字符串 |
执行结果说明 |
| data |
对象 |
对象数组，每个元素详见上自定义data数据表 |
data(自定义字段列表)
| 参数名 |
类型 |
说明 |
| id |
Long |
自定义id |
| contentType |
String |
自定义字段类型：text单行文本，phone电话号码，date日期，datetime时间，droplist下拉列表，number整数，numeric实数，chained_droplist级联，area_text多行文本，checkbox多选 |
| businessType |
int |
业务类型，100：客户，101：客户群，110：员工 |
| fieldCode |
String |
自定义字段码值 |
| status |
int |
状态 1启用，0禁用 |
| name |
String |
自定义字段名称 |
| optionList |
对象List |
下拉/级联/多选类型的选项 |
| options |
String |
optionList的转换字符串 |
1.1.4. 请求示例
curl --location --request POST 'https://[子域名].wefeng360.com/api/v1/customField/list?sign=fbdd2e45e3bd9d1f1e4915863cff62c2d6f901490070741b821ad55d7e231552×tamp=1619143576' --header 'Content-Type: application/json'
1.1.5. 入参
{
"type":"100"
}
1.1.6. 返回示例
{
"succeed": true,
"code": 200,
"bizCode": "000000",
"message": "OK",
"visible": false,
"paging": {
"pageNum": 1,
"pageSize": 12,
"total": 12
},
"data": [
{
"businessType": 100,
"fieldCode": "CustomField_5201",
"status": 1,
"name": "1-单行文本",
"options": null,
"optionsList": null,
"contentType": "text",
"id": 5201
},
{
"businessType": 100,
"fieldCode": "CustomField_5202",
"status": 1,
"name": "2-多行文本",
"options": null,
"optionsList": null,
"contentType": "area_text",
"id": 5202
},
{
"businessType": 100,
"fieldCode": "CustomField_5203",
"status": 1,
"name": "3-下拉列表",
"options": "[{\"key\":1,\"value\":\"1\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false},{\"key\":2,\"value\":\"2\",\"orders\":2,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false},{\"key\":3,\"value\":\"选项3\",\"orders\":3,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false}]",
"optionsList": [
{
"key": 1,
"value": "1",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
},
{
"key": 2,
"value": "2",
"orders": 2,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
},
{
"key": 3,
"value": "选项3",
"orders": 3,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
}
],
"contentType": "droplist",
"id": 5203
},
{
"businessType": 100,
"fieldCode": "CustomField_5204",
"status": 1,
"name": "4-多选",
"options": "[{\"key\":1,\"value\":\"选项1\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false},{\"key\":2,\"value\":\"选项2\",\"orders\":2,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false}]",
"optionsList": [
{
"key": 1,
"value": "选项1",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
},
{
"key": 2,
"value": "选项2",
"orders": 2,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
}
],
"contentType": "checkbox",
"id": 5204
},
{
"businessType": 100,
"fieldCode": "CustomField_5205",
"status": 1,
"name": "5-时间",
"options": null,
"optionsList": null,
"contentType": "datetime",
"id": 5205
},
{
"businessType": 100,
"fieldCode": "CustomField_5206",
"status": 1,
"name": "6-整数",
"options": null,
"optionsList": null,
"contentType": "number",
"id": 5206
},
{
"businessType": 100,
"fieldCode": "CustomField_5207",
"status": 1,
"name": "7-实数",
"options": null,
"optionsList": null,
"contentType": "numeric",
"id": 5207
},
{
"businessType": 100,
"fieldCode": "CustomField_5208",
"status": 1,
"name": "8-级联",
"options": "[{\"key\":1,\"value\":\"北京\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[{\"key\":2,\"value\":\"西城区\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[{\"key\":3,\"value\":\"西直门\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false}],\"selected\":false}],\"selected\":false},{\"key\":4,\"value\":\"天津\",\"orders\":2,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[{\"key\":5,\"value\":\"和平区\",\"orders\":1,\"defaultFlag\":0,\"deleteFlag\":0,\"subOptionList\":[],\"selected\":false}],\"selected\":false}]",
"optionsList": [
{
"key": 1,
"value": "北京",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": [
{
"key": 2,
"value": "西城区",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": [
{
"key": 3,
"value": "西直门",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
}
]
}
]
},
{
"key": 4,
"value": "天津",
"orders": 2,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": [
{
"key": 5,
"value": "和平区",
"orders": 1,
"defaultFlag": 0,
"deleteFlag": 0,
"subOptionList": []
}
]
}
],
"contentType": "chained_droplist",
"id": 5208
},
{
"businessType": 100,
"fieldCode": "CustomField_5209",
"status": 1,
"name": "9-电话",
"options": null,
"optionsList": null,
"contentType": "phone",
"id": 5209
},
{
"businessType": 100,
"fieldCode": "CustomField_5210",
"status": 0,
"name": "5-日期",
"options": null,
"optionsList": null,
"contentType": "date",
"id": 5210
},
{
"businessType": 100,
"fieldCode": "CustomField_5615",
"status": 0,
"name": "知识库权限",
"options": null,
"optionsList": null,
"contentType": "text",
"id": 5615
},
{
"businessType": 100,
"fieldCode": "CustomField_10235",
"status": 1,
"name": "10-哈哈",
"options": null,
"optionsList": null,
"contentType": "text",
"id": 10235
}
]
}