Description

Query custom object list

Request Specification

Request Method: POST + application/json

Request Path: https://${cloud domain}/cgi/crm/custom/v2/data/query?thirdTraceId=${random string}

Request Headers: Refer to Common Parameters

This API only applies to custom objects (objects whose ApiName ends with __c)

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
dataObjectApiName	String	Yes	Object's api_name, fixed value: DeliveryNoteProductObj
find_explicit_total_num	String	No	Whether to return total count (true: returns total count, false: doesn't return total count (default true. Setting to false can improve API response speed))
search_query_info	String	Yes	Query conditions
limit	Int	Yes	Pagination size (maximum value: 100)
offset	Int	Yes	Offset (starts from 0, must be an integer multiple of limit)
filters	List	Yes	Filter conditions list
field_name	String	Yes	Field name
field_values	List	Yes	Field values
operator	String	Yes	Operator
orders	List	Yes	Sorting
fieldName	String	Yes	Field name
isAsc	Boolean	Yes	Ascending order (if true, sort in ascending order; if false, sort in descending order)

Request Example

{
  "includeNull": true,
  "data": {
    "find_explicit_total_num": "hello",
    "search_query_info": {
      "offset": 0,
      "limit": 1,
      "orders": [
        {
          "fieldName": "hello",
          "isAsc": true
        }
      ],
      "filters": [
        {
          "operator": "EQ",
          "field_name": "name",
          "field_values": []
        }
      ]
    },
    "dataObjectApiName": ""
  }
}

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	View error codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment, as errorMessage may change;

Special Instructions

Operator Parameter Description

Parameter	Meaning	Parameter	Meaning
EQ	=	GT	>
LT	<	GTE	>=
LTE	<=	N	<>
LIKE	LIKE	NLIKE	NOT LIKE
IS	IS	ISN	IS NOT
IN	IN	NIN	NOT IN
BETWEEN	BETWEEN	NBETWEEN	NOT BETWEEN
STARTWITH	LIKE%	ENDWITH	%LIKE
CONTAINS	Array contains