Description

Query detailed object description

Request Specification

Method: POST + application/json

Endpoint: https://${cloud domain}/cgi/crm/v2/object/describe?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
includeNull	Boolean	No	Whether to include null fields. false: not returned, true: returned. Default is false
data	Map	Yes	Data map
apiName	String	Yes	Object apiName
includeDetail	Boolean	Yes	Whether to include subordinate objects

Request Example

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

Response Example

{
  "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": "Lock rule",
          "is_unique": false,
          "rules": [],
          "default_value": "default_lock_rule",
          "label": "Lock rule",
          "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": "Off-shelf time",
          "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": "Off-shelf time",
          "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": "Standard price",
          "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": "Standard price",
          "currency_unit": "￥",
          "is_need_convert": false,
          "api_name": "price",
          "is_index_field": false,
          "help_text": "",
          "status": "released"
        }
      }
    }
  }
}

Field Suffix Explanation

Some fields contain special suffixes with different meanings for different field types, as detailed below.

Suffix	Field Types	Description
__r	country, province, city, district, town	Stores label value
	object_reference_many, object_reference	Multiple selection: apiNameList Normal: apiname
	employee, out_employee	Employee information
	department, last_modified_by	Department information
	relevant_team	Relevant team member names
	teamMemberEmployee	User information
	master_detail, dimension
__l	department_many, last_modified_by	Department information (List)
	employee_many	Employee information (list)
__o	select_many, select_one	Other information
	rich text	Plain text version of rich text
__v	quote	Option value's value
__p	phone_number	Phone number attribution information
__relation_ids	object_reference, master_detail
__e	rich text	Untreated rich text (same as without __e)