Deprecated Interface - Not Recommended for Use!!!

Description

Query preset object list

Request Specification

Request Method: POST + application/json

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

Request Parameters

Parameter	Type	Required	Description
corpAccessToken	String	Yes	corpAccessToken (returned by Get Token API (opens new window))
corpId	String	Yes	corpId (returned by Get Token API (opens new window))
currentOpenUserId	String	Yes	currentOpenUserId (returned by Query Employee by Phone API (opens new window))
data	Map	Yes	Data map
dataObjectApiName	String	Yes	Object's api_name
find_explicit_total_num	Boolean	No	Whether to return total count (true->returns total, false->doesn't return total count. Default true. Setting false can improve API response speed)
search_query_info	Map	Yes	Query conditions
limit	Int	Yes	Pagination size (max value 100)
offset	Int	Yes	Offset (starts from 0, must be integer multiple of limit)
filters	List	Yes	Filter conditions list
field_name	String	Yes	Field name
field_values	List[String]	Yes	Field values
operator	String	Yes	Operator, see [operator parameter description] below
orders	List	Yes	Query conditions
fieldName	String	Yes	Field name
isAsc	Boolean	Yes	Sort order (true for ascending, false for descending)
fieldProjection	List[String]	Yes	Return field list, using apiName from object fields

Operator Parameter Description

Parameter	Meaning	Description	Parameter	Meaning	Description
EQ	Equal		N	Not Equal	Can query nulls
GT	Greater Than		GTE	Greater Than or Equal
LT	Less Than		LTE	Less Than or Equal
LIKE	Contains		NLIKE	Not Contains
IS	Is Null		ISN	Is Not Null
IN	In		NIN	Not In
BETWEEN	Between		NBETWEEN	Not Between
STARTWITH	Starts With		ENDWITH	Ends With
HASANYOF	Has Any Of		NHASANYOF	Has No Overlap

Request Example

{
  "corpAccessToken": "{corpAccessToken}",
  "currentOpenUserId": "{currentOpenUserId}",
  "corpId": "{corpId}",
  "data": {
    "find_explicit_total_num": true,
    "search_query_info": {
      "offset": 0,
      "limit": 1,
      "orders": [
        {
          "fieldName": "create_time",
          "isAsc": true
        }
      ],
      "fieldProjection": [
        "name"
      ],
      "filters": [
        {
          "operator": "EQ",
          "field_name": "name",
          "field_values": [
            "603dabc14ae65400011aec90"
          ]
        }
      ]
    },
    "dataObjectApiName": "CampaignMembersObj"
  }
}

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;