查询对象描述
POST
https://open.fxiaoke.com/cgi/crm/v2/object/describe
查询对象描述
返回数据中的字段说明
| 字段 | 说明 |
|---|---|
| fields.*.define_type | custom：自定义类型，表明该字段是手动添加的字段system：系统类型，表明该字段是系统预设的字段 |
| fields.*.type | 字段类型，详情参考：创建/修改对象接口说明 |
| fields.*.api_name | 字段的ApiName，唯一标识 |
| fields.*.is_active | 字段是否启用 |
| fields.*.label | 字段名称 |
| fields.*.is_required | 字段是否必填 |
| fields.*.options | 多选或者单选时的选项值 |
请求参数
Body 参数application/json
返回响应
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://open.fxiaoke.com/cgi/crm/v2/object/describe' \
--header 'Content-Type: application/json' \
--data-raw '{
"corpAccessToken": "${corpAccessToken}",
"corpId": "${corpId}",
"currentOpenUserId": "${currentOpenUserId}",
"includeDetail": true,
"apiName": "SPUObj"
}'响应示例响应示例
{
"traceId": "E-O.fktest188.1453-58620bb77fad4b06",
"data": {
"describe": {
"created_by": "-1000",
"api_name": "SPUObj",
"display_name_r": "商品",
"fields": {
"lock_rule": {
"describe_api_name": "SPUObj",
"is_index": false,
"is_active": true,
"create_time": 1545708954665,
"description": "锁定规则",
"is_unique": false,
"default_value": "default_lock_rule",
"rules": [],
"label": "锁定规则",
"type": "lock_rule",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_rule",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": false,
"label_r": "锁定规则",
"index_name": "s_4"
},
"batch_sn": {
"describe_api_name": "SPUObj",
"is_index": true,
"is_active": false,
"create_time": 1545708954690,
"description": "批次与序列号管理",
"is_unique": false,
"default_value": "1",
"label": "批次与序列号管理",
"type": "select_one",
"is_need_convert": false,
"is_required": true,
"api_name": "batch_sn",
"options": [
{
"label": "不开启",
"value": "1"
},
{
"label": "开启批次管理",
"value": "2"
},
{
"label": "开启序列号管理",
"value": "3"
}
],
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "批次与序列号管理",
"is_index_field": false,
"index_name": "s_1",
"config": {
"edit": 0,
"enable": 0,
"display": 1,
"remove": 0
}
},
"remark": {
"describe_api_name": "SPUObj",
"is_index": true,
"is_active": true,
"create_time": 1545708954697,
"pattern": "",
"description": "备注",
"is_unique": false,
"label": "备注",
"type": "long_text",
"is_need_convert": false,
"is_required": false,
"api_name": "remark",
"define_type": "package",
"is_extend": false,
"is_single": false,
"label_r": "备注",
"is_index_field": false,
"index_name": "t_4",
"config": {
"edit": 1,
"enable": 1,
"display": 1,
"remove": 1,
"attrs": {
"help_text": 1
}
},
"max_length": 2000
},
"lock_user": {
"describe_api_name": "SPUObj",
"is_index": false,
"is_active": true,
"create_time": 1545708954708,
"description": "加锁人",
"is_unique": false,
"label": "加锁人",
"type": "employee",
"is_need_convert": false,
"is_required": false,
"api_name": "lock_user",
"define_type": "package",
"is_extend": false,
"is_index_field": false,
"is_single": true,
"label_r": "加锁人",
"index_name": "a_1"
},
"commodity_label": {
"describe_api_name": "SPUObj",
"is_index": true,
"is_active": true,
"create_time": 1613962242922,
"description": "商品标签",
"is_unique": false,
"label": "商品标签",
"type": "select_many",
"is_need_convert": false,
"is_required": false,
"api_name": "commo
扫码加入交流群修改于 2022-01-05 07:51:13