Description

Query the list of high seas objects based on specified conditions.

Request Specification

Request Method: POST + application/json

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

Request 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
dataObjectApiName	String	Yes	Object's api_name, fixed value: HighSeasObj
find_explicit_total_num	Boolean	No	Whether to return total count (true->returns total, false->doesn't return total. Default: true. Setting to false can improve API response speed)
search_query_info	Map	Yes	Query Condition Specification
limit	Int	Yes	Pagination size (max: 100)
offset	Int	Yes	Offset (starts from 0, must be 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	Ascending order (true for ascending, false for descending)
fieldProjection	List[String]	Yes	Return fields list, values are apiName from object fields

Operator Parameter Description

You can directly use query conditions from the object list page. See How to Get Query Conditions from List

Parameter	Meaning	Description	Parameter	Meaning	Description
EQ	Equal		N	Not equal	Can query null values
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 overlap		NHASANYOF	No overlap

Request Example

{
  "includeNull": true,
  "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": "HighSeasObj"
  },
}

Response Parameters

Parameter	Type	Description
traceId	string	Request unique ID
errorDescription	string	Error description
data	Map	Parameter details, please call Query Object Description API
errorMessage	string	Error message
errorCode	Int	View Error Codes

Response Example

{
  "traceId": "E-O.827xxxxxx",
  "errorDescription": "success",
  "data": {
    "created_by__r": {},
    "lock_status": "0",
    "is_deleted": false,
    "create_time": 1612247399397,
    "name": "xxxxxx",
    "_id": "69046aexxxxxxx"
  },
  "errorMessage": "OK",
  "errorCode": 0
}

Notes

• Do not use the message field in the response for logical judgment as errorMessage may change;
• If a field's value is empty, the field will not be returned;

• Operator Parameter Description

The return values of this API correspond to object-related fields. For details, see Explanation of Approval Flow Instance Object Fields. The following parameters are unique return values for this API. For error codes, refer to Global Error Codes.

| 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 | |