下拉列表数据
获取下拉列表数据
- API 地址:
metadata/picklist - HTTP 方法:GET
- 授权方式:通用授权
请求参数
| 参数 | 类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| entity | string | 是 | 实体内部名称 |
| fields | string | 否 | 字段内部名称,不填写则返回实体的所有下拉列表字段项 |
返回数据示例
{
"error_code": 0,
"error_msg": "调用成功",
"data": [{
"field": "typeCode",
"values": [
{ "value": 0, "label": "正式客户" },
{ "value": 1, "label": "潜在客户" },
{ "value": 2, "label": "合作伙伴" }]
}]
}
返回数据说明
| 字段 | 类型 | 字段说明 |
|---|---|---|
| field | string | 字段内部名称 |
| values | array | picklist 列表 |
| values/value | int | picklist 值 |
| values/label | string | picklist 值显示名称 |
更新或新增下拉列表项 4.6
- API 地址:
metadata/picklist-edit - HTTP 方法:POST
- 授权方式:通用授权
请求参数
| 参数 | 类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| entity | string | 是 | 实体内部名称 |
| field | string | 是 | 字段内部名称,必须是 picklist 类型字段 |
| value | int | 否 | picklist 值。用于匹配已有 picklist 项,匹配到则更新,未填(或未匹配到)则新增 |
| label | string | 是 | picklist 值显示名称。注意显示名称不能重复,若存在重复系统会返回错误 |
返回数据示例
{
"error_code": 0,
"error_msg": "调用成功",
"data": {
"field": "typeCode",
"value": 2,
"label": "正式客户"
}
}
返回数据说明
| 字段 | 类型 | 字段说明 |
|---|---|---|
| field | string | 字段内部名称 |
| value | int | picklist 值 |
| label | string | picklist 值显示名称 |
移除下拉列表项 4.6
- API 地址:
metadata/picklist-remove - HTTP 方法:POST
- 授权方式:通用授权
请求参数
| 参数 | 类型 | 是否必须 | 参数说明 |
|---|---|---|---|
| entity | string | 是 | 实体内部名称 |
| field | string | 是 | 字段内部名称,必须是 picklist 类型字段 |
| value | int | 否 | picklist 值 |
| label | string | 否 | picklist 值显示名称。value 或 label 必须指定一个,用于匹配待移除项 |
返回数据示例
{
"error_code": 0,
"error_msg": "调用成功",
"data": {
"field": "typeCode",
"value": 2
}
}
返回数据说明
| 字段 | 类型 | 字段说明 |
|---|---|---|
| field | string | 字段内部名称 |
| value | int | 被移除的 picklist 项,如未匹配到任何,则返回 -1 |