描述

查询对象详细描述

请求说明

请求方式：POST + application/json

请求路径：https://${填入所在云的域名}/cgi/crm/v2/object/describe?thirdTraceId=${随机字符串}

请求头填写 ：参考公共参数填写

请求参数

参数	类型	是否必填	说明
includeNull	Boolean	否	是否包含 null 字段,false:不返回,true:返回，不传默认为false
data	Map	是	数据map
apiName	String	是	对象apiName
includeDetail	Boolean	是	是否包括从对象

请求示例

{
  "includeNull": true,
  "includeDetail": true,
  "data": {
    "apiName": "ProductObj"
  }
}

返回示例

{
  "traceId": "E-O.fsojdz.1003-20251106185717-2ac1a1",
  "data": {
    "describe": {
      "icon_index": 0,
      "api_name": "ProductObj",
      "icon_path": "",
      "fields": {
        "lock_rule": {
          "describe_api_name": "ProductObj",
          "is_index": false,
          "is_active": true,
          "create_time": 1599808855938,
          "auto_adapt_places": false,
          "description": "锁定规则",
          "is_unique": false,
          "rules": [],
          "default_value": "default_lock_rule",
          "label": "锁定规则",
          "type": "lock_rule",
          "is_need_convert": false,
          "is_required": false,
          "api_name": "lock_rule",
          "define_type": "package",
          "is_single": false,
          "is_index_field": false,
          "index_name": "s_4"
        },
        "off_shelves_time": {
          "describe_api_name": "ProductObj",
          "default_is_expression": false,
          "auto_adapt_places": false,
          "description": "下架时间",
          "is_unique": false,
          "type": "date_time",
          "default_to_zero": false,
          "is_required": false,
          "define_type": "package",
          "is_single": false,
          "is_extend": false,
          "index_name": "l_1",
          "is_index": true,
          "is_active": true,
          "create_time": 1547943504185,
          "default_value": "",
          "label": "下架时间",
          "time_zone": "GMT+8",
          "is_need_convert": false,
          "api_name": "off_shelves_time",
          "date_format": "yyyy-MM-dd HH:mm",
          "is_index_field": false,
          "help_text": ""
        },
        "extend_obj_data_id": {
          "describe_api_name": "ProductObj",
          "default_is_expression": false,
          "is_index": false,
          "is_active": true,
          "create_time": 1547943504185,
          "auto_adapt_places": false,
          "pattern": "",
          "description": "extend_obj_data_id",
          "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_single": false,
          "is_extend": false,
          "is_index_field": false,
          "index_name": "t_2",
          "max_length": 100,
          "help_text": ""
        },
        "price": {
          "describe_api_name": "ProductObj",
          "default_is_expression": true,
          "auto_adapt_places": false,
          "description": "标准价格",
          "is_unique": false,
          "type": "currency",
          "decimal_places": 2,
          "default_to_zero": true,
          "is_required": true,
          "define_type": "package",
          "is_single": false,
          "index_name": "d_3",
          "max_length": 14,
          "is_index": true,
          "is_active": true,
          "create_time": 1547943504185,
          "length": 12,
          "default_value": "0",
          "label": "标准价格",
          "currency_unit": "￥",
          "is_need_convert": false,
          "api_name": "price",
          "is_index_field": false,
          "help_text": "",
          "status": "released"
        }
      }
    }
  }
}

字段说明

有些字段带有特殊后缀，在下表中会具体说明。同一特殊后缀用于不同的字段类型后面有不同的含义，具体参见下表。

字段名后缀	字段类型	该字段含义
__r	country（国家）,province（省份）,city（城市）,district(地区),town(城镇)	存储label值
	,object_reference_many(查找关联多选)object_reference（查找关联）	多选：apiNameList正常：apiname
	employee（人员）out_employee(外部人员)	人员信息
	department（部门）last_modified_by	部门信息
	relevant_team（相关团队）	相关团队成员名称
	teamMemberEmployee(团队成员)	用户信息
	master_detail（主从字段）,dimension(尺寸)
__l	department_many（部门多选）last_modified_by	部门信息（List）
	employee_many（人员多选）	人员信息（list）
__o	select_many（多选）select_one（单选）	other的信息
	富文本	纯文本化后的富文本信息
__v	quote(引用字段)	选项值的value值
__p	phone_number(电话号码)	手机归属地信息
__relation_ids	object_reference(查找关联多选)，master_detail（主从）
__e	富文本	未经处理的富文本，与不带__e一致