查询对象描述
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 | 多选或者单选时的选项值 |
请求示例请求示例
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": "commodity_label", "options": [ { "not_usable": false, "label": "新品", "value": "option1", "config": { "edit": 0, "enable": 0, "remove": 0 } }, { "not_usable": false, "label": "热销", "value": "option2", "config": { "edit": 0, "enable": 0, "remove": 0 } }, { "not_usable": false, "label": "清仓", "value": "option3", "config": { "edit": 0, "enable": 0, "remove": 0 } }, { "not_usable": false, "label": "推荐", "value": "option4", "config": { "edit": 0, "enable": 0, "remove": 0 } }, { "not_usable": false, "label": "重要", "value": "option5", "config": { "edit": 0, "enable": 0, "remove": 0 } }, { "not_usable": false, "label": "其他", "value": "option6", "config": { "edit": 0, "enable": 0, "remove": 0 } } ], "define_type": "package", "is_index_field": true, "is_single": false, "label_r": "商品标签", "config": { "add": 0, "edit": 1, "enable": 1, "default_value": 1, "attrs": { "is_readonly": 1, "is_required": 1, "api_name": 1, "options": 0, "default_value": 1, "label": 1, "help_text": 1 }, "help_text": 1 }, "index_name": "a_3" }, "extend_obj_data_id": { "describe_api_name": "SPUObj", "default_is_expression": false, "is_index": false, "is_active": true, "create_time": 1545708954722, "pattern": "", "is_unique": false, "default_value": "", "label": "extend_obj_data_id", "type": "text", "default_to_zero": false, "is_required": false, "api_name": "extend_obj_data_id", "define_type": "system", "is_extend": false, "is_single": false, "is_index_field": false, "index_name": "t_1", "max_length": 100 }, "is_deleted": { "describe_api_name": "SPUObj", "is_index": false, "create_time": 1545749198325, "is_unique": false, "description": "is_deleted", "default_value": false, "label": "is_deleted", "type": "true_or_false", "is_need_convert": false, "is_required": false, "api_name": "is_deleted", "define_type": "system", "index_name": "is_del" }, "life_status_before_invalid": { "describe_api_name": "SPUObj", "is_index": false, "is_active": true, "create_time": 1545708954736, "pattern": "", "description": "作废前生命状态", "is_unique": false, "label": "作废前生命状态", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "life_status_before_invalid", "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": false, "label_r": "作废前生命状态", "index_name": "t_2", "max_length": 256 }, "mnemonic_code": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1567895710152, "pattern": "", "description": "助记码", "is_unique": true, "label": "助记码", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "mnemonic_code", "define_type": "package", "is_index_field": true, "is_single": false, "config": { "add": 1, "edit": 1, "enable": 1, "default_value": 1, "attrs": { "is_readonly": 1, "is_required": 1, "api_name": 1, "default_value": 1, "label": 1, "help_text": 1 }, "help_text": 1 }, "index_name": "t_5", "max_length": 100 }, "owner_department": { "describe_api_name": "SPUObj", "default_is_expression": false, "is_index": false, "is_active": true, "create_time": 1545708954736, "pattern": "", "is_unique": false, "default_value": "", "label": "负责人主属部门", "type": "text", "default_to_zero": false, "is_need_convert": false, "is_required": false, "api_name": "owner_department", "define_type": "package", "is_extend": false, "is_single": true, "label_r": "负责人主属部门", "is_index_field": false, "index_name": "owner_dept", "config": { "add": 0, "edit": 0, "enable": 0, "display": 1, "remove": 0, "attrs": { "label": 0 } }, "max_length": 100 }, "out_owner": { "describe_api_name": "SPUObj", "is_index": false, "is_active": true, "create_time": 1545749198325, "is_unique": false, "label": "外部负责人", "type": "employee", "is_need_convert": false, "is_required": false, "api_name": "out_owner", "define_type": "system", "is_single": true, "index_name": "o_owner", "config": { "display": 1 } }, "owner": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954665, "is_unique": false, "label": "负责人", "type": "employee", "is_need_convert": false, "is_required": true, "api_name": "owner", "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": true, "label_r": "负责人", "config": { "add": 0, "edit": 0, "enable": 0, "display": 1, "remove": 0, "attrs": { "label": 0 } }, "index_name": "owner" }, "standard_price": { "describe_api_name": "SPUObj", "default_is_expression": true, "description": "价格", "is_unique": false, "type": "currency", "decimal_places": 2, "default_to_zero": true, "is_required": true, "define_type": "package", "is_extend": false, "is_single": false, "label_r": "价格", "index_name": "d_1", "is_index": true, "is_active": true, "create_time": 1545708954665, "length": 14, "default_value": "0", "label": "价格", "currency_unit": "¥", "is_need_convert": false, "api_name": "standard_price", "is_index_field": false, "config": { "config": { "edit": 1, "enable": 0, "display": 1, "remove": 0, "attrs": { "is_required": 0, "api_name": 0, "is_unique": 0, "default_value": 0, "label": 0, "help_text": 0, "max_length": 1, "decimal_places": 1 } } }, "round_mode": 4 }, "lock_status": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954671, "description": "锁定状态", "is_unique": false, "default_value": "0", "label": "锁定状态", "type": "select_one", "is_need_convert": false, "is_required": false, "api_name": "lock_status", "options": [ { "label": "未锁定", "value": "0" }, { "label": "锁定", "value": "1" } ], "define_type": "package", "is_extend": false, "is_single": false, "label_r": "锁定状态", "is_index_field": false, "index_name": "s_5", "config": {} }, "last_modified_time": { "describe_api_name": "SPUObj", "is_index": true, "create_time": 1545749198325, "is_unique": false, "description": "last_modified_time", "label": "最后修改时间", "type": "date_time", "time_zone": "", "is_need_convert": false, "is_required": false, "api_name": "last_modified_time", "define_type": "system", "date_format": "yyyy-MM-dd HH:mm:ss", "index_name": "md_time" }, "create_time": { "describe_api_name": "SPUObj", "is_index": true, "create_time": 1545749198325, "is_unique": false, "description": "create_time", "label": "创建时间", "type": "date_time", "time_zone": "", "is_need_convert": false, "is_required": false, "api_name": "create_time", "define_type": "system", "date_format": "yyyy-MM-dd HH:mm:ss", "index_name": "crt_time" }, "life_status": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954696, "is_unique": false, "default_value": "normal", "label": "生命状态", "type": "select_one", "is_need_convert": false, "is_required": false, "api_name": "life_status", "options": [ { "label": "未生效", "value": "ineffective" }, { "label": "审核中", "value": "under_review" }, { "label": "正常", "value": "normal" }, { "label": "变更中", "value": "in_change" }, { "label": "作废", "value": "invalid" } ], "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": false, "label_r": "生命状态", "config": { "add": 0, "edit": 0, "enable": 0, "display": 1, "remove": 0, "attrs": { "is_required": 0, "options": 0, "default_value": 0, "label": 0, "help_text": 0 } }, "index_name": "s_3" }, "order_field": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954696, "pattern": "", "length": 18, "is_unique": false, "default_value": "", "label": "排序", "type": "number", "decimal_places": 0, "is_need_convert": false, "is_required": false, "api_name": "order_field", "define_type": "package", "is_single": false, "label_r": "排序", "is_index_field": false, "index_name": "t_3", "round_mode": 4, "max_length": 100 }, "last_modified_by": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545749198325, "is_unique": false, "label": "最后修改人", "type": "employee", "is_need_convert": true, "is_required": false, "api_name": "last_modified_by", "define_type": "system", "is_single": true, "index_name": "md_by" }, "is_spec": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954708, "pattern": "", "description": "是否开启规格", "is_unique": false, "default_value": false, "label": "是否有规格", "type": "true_or_false", "is_need_convert": false, "is_required": true, "api_name": "is_spec", "options": [ { "label": "否", "value": false, "config": { "edit": 1, "enable": 0, "remove": 0 } }, { "label": "是", "value": true, "config": { "edit": 1, "enable": 0, "remove": 0 } } ], "define_type": "package", "is_extend": false, "is_single": false, "label_r": "是否有规格", "is_index_field": false, "index_name": "b_1", "config": { "edit": 1, "enable": 0, "display": 1, "remove": 0, "attrs": { "is_required": 0 } } }, "out_tenant_id": { "describe_api_name": "SPUObj", "is_index": false, "is_active": true, "create_time": 1545749198325, "pattern": "", "is_unique": false, "description": "out_tenant_id", "label": "外部企业", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "out_tenant_id", "define_type": "system", "index_name": "o_ei", "config": { "display": 0 }, "max_length": 200 }, "version": { "describe_api_name": "SPUObj", "is_index": false, "create_time": 1545749198325, "length": 8, "is_unique": false, "description": "version", "label": "version", "type": "number", "decimal_places": 0, "is_need_convert": false, "is_required": false, "api_name": "version", "define_type": "system", "index_name": "version", "round_mode": 4 }, "created_by": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545749198325, "is_unique": false, "label": "创建人", "type": "employee", "is_need_convert": true, "is_required": false, "api_name": "created_by", "define_type": "system", "is_single": true, "index_name": "crt_by" }, "relevant_team": { "describe_api_name": "SPUObj", "embedded_fields": { "teamMemberEmployee": { "is_index": true, "is_need_convert": true, "is_required": false, "api_name": "teamMemberEmployee", "is_unique": false, "define_type": "package", "description": "成员员工", "label": "成员员工", "type": "employee", "is_single": true, "help_text": "成员员工" }, "teamMemberRole": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberRole", "options": [ { "label": "负责人", "value": "1" }, { "label": "普通成员", "value": "4" } ], "is_unique": false, "define_type": "package", "description": "成员角色", "label": "成员角色", "type": "select_one", "help_text": "成员角色" }, "teamMemberPermissionType": { "is_index": true, "is_need_convert": false, "is_required": false, "api_name": "teamMemberPermissionType", "options": [ { "label": "只读", "value": "1" }, { "label": "读写", "value": "2" } ], "is_unique": false, "define_type": "package", "description": "成员权限类型", "label": "成员权限类型", "type": "select_one", "help_text": "成员权限类型" } }, "is_index": false, "is_active": true, "create_time": 1545708954708, "is_unique": false, "label": "相关团队", "type": "embedded_object_list", "is_need_convert": false, "is_required": false, "api_name": "relevant_team", "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": false, "label_r": "相关团队", "index_name": "a_team", "help_text": "相关团队" }, "picture": { "describe_api_name": "SPUObj", "file_amount_limit": 1, "is_index": false, "is_active": true, "create_time": 1545708954708, "description": "图片", "is_unique": false, "label": "图片", "type": "image", "is_watermark": false, "file_size_limit": 10485760, "is_need_convert": false, "is_required": false, "api_name": "picture", "define_type": "package", "is_single": false, "label_r": "图片", "is_index_field": false, "index_name": "a_2", "support_file_types": [], "config": { "add": 0, "edit": 1, "enable": 1, "display": 1, "remove": 0, "attrs": { "file_amount_limit": 1, "api_name": 0, "label": 1, "is_watermark": 1, "help_text": 1 } } }, "record_type": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954714, "description": "record_type", "is_unique": false, "label": "业务类型", "type": "record_type", "is_need_convert": false, "is_required": true, "api_name": "record_type", "options": [ { "is_active": true, "api_name": "default__c", "description": "预设业务类型", "label": "预设业务类型" }, { "is_active": true, "api_name": "record_RqQ0v__c", "description": "", "label": "业务类型(示例)" } ], "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": false, "label_r": "业务类型", "config": { "add": 0, "edit": 0, "enable": 0, "display": 1, "remove": 0, "attrs": { "label": 0 } }, "index_name": "r_type" }, "product_line": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954722, "pattern": "", "is_unique": false, "label": "产品线", "type": "select_one", "is_need_convert": false, "is_required": false, "api_name": "product_line", "options": [ { "label": "产品线1", "value": "1", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "产品线2", "value": "2", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "产品线3", "value": "3", "config": { "edit": 1, "enable": 1, "remove": 1 } } ], "define_type": "package", "is_extend": false, "is_index_field": false, "is_single": false, "label_r": "产品线", "config": { "add": 1, "edit": 1, "enable": 1, "display": 1, "remove": 0, "attrs": { "options": 1 } }, "index_name": "s_6" }, "unit": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954736, "description": "单位", "is_unique": false, "label": "单位", "type": "select_one", "is_need_convert": false, "is_required": true, "api_name": "unit", "options": [ { "label": "辆", "value": "18", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "册", "value": "16", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "栋", "value": "19", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "簇", "value": "15", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "Pcs", "value": "14", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "张", "value": "17", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "个", "value": "1", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "块", "value": "2", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "只", "value": "3", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "把", "value": "4", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "枚", "value": "5", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "条", "value": "6", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "瓶", "value": "7", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "盒", "value": "8", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "套", "value": "9", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "箱", "value": "10", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "米", "value": "11", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "千克", "value": "12", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "吨", "value": "13", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "双2", "value": "KOuBdbiu", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "打1", "value": "47gGKOqL", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "坑1", "value": "MQyLMzNS", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "地", "value": "Y1NzxEVj", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "哈", "value": "qHdtL3Q6", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "看", "value": "QZWX7oyr", "config": { "edit": 1, "enable": 1, "remove": 1 } }, { "label": "也", "value": "xbovvz2b", "config": { "edit": 1, "enable": 1, "remove": 1 } } ], "define_type": "package", "is_index_field": false, "is_single": false, "label_r": "单位", "config": { "add": 1, "edit": 1, "enable": 0, "display": 1, "remove": 1, "attrs": { "options": 1 } }, "index_name": "s_8" }, "data_own_department": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545749198325, "is_unique": false, "label": "归属部门", "type": "department", "is_need_convert": false, "is_required": false, "api_name": "data_own_department", "define_type": "package", "is_single": true, "index_name": "data_owner_dept_id" }, "name": { "describe_api_name": "SPUObj", "is_index": true, "is_active": true, "create_time": 1545708954665, "pattern": "", "description": "name", "is_unique": true, "default_value": "", "label": "商品名称", "type": "text", "is_required": true, "api_name": "name", "define_type": "package", "is_extend": false, "is_single": false, "label_r": "商品名称", "is_index_field": false, "index_name": "name", "config": { "edit": 1, "enable": 0, "display": 1, "remove": 0 }, "max_length": 256 }, "order_by": { "describe_api_name": "SPUObj", "is_index": false, "create_time": 1545749198325, "length": 8, "is_unique": false, "description": "order_by", "label": "order_by", "type": "number", "decimal_places": 0, "is_need_convert": false, "is_required": false, "api_name": "order_by", "define_type": "system", "index_name": "l_by", "round_mode": 4 }, "_id": { "describe_api_name": "SPUObj", "is_index": false, "is_active": true, "create_time": 1545749198325, "pattern": "", "is_unique": false, "description": "_id", "label": "_id", "type": "text", "is_need_convert": false, "is_required": false, "api_name": "_id", "define_type": "system", "index_name": "_id", "max_length": 200 }, "category": { "describe_api_name": "SPUObj", "expression_type": "tree", "is_index": true, "is_active": true, "create_time": 1547568008280, "description": "产品分类", "is_unique": false, "label": "产品分类", "type": "select_one", "is_need_convert": false, "is_required": true, "api_name": "category", "options": [ { "label": "k3 cloud来源", "value": "6" }, { "label": "KIS来源", "value": "8" }, { "label": "老kis", "value": "7" }, { "label": "办公用品", "value": "1" }, { "label": "蔬1ssss菜1", "value": "11" }, { "label": "蔬1菜1", "value": "10" }, { "label": "蔬菜1", "value": "9" }, { "label": "数码产品", "value": "2" }, { "label": "服务", "value": "3" }, { "label": "家用电器", "value": "4" }, { "label": "家居用品", "value": "5" } ], "define_type": "package", "is_extend": false, "is_single": false, "label_r": "产品分类", "is_index_field": false, "index_name": "s_2", "config": { "edit": 1, "enable": 0, "display": 1, "remove": 0, "attrs": { "is_required": 0 } } } } }, "detailObjectDescribeList": [] }, "errorDescription": "success", "errorMessage": "success", "errorCode": 0 }
请求参数
Body 参数application/json