Description

Query Knowledge Category Object List by Conditions.

Request Specification

Method: POST + application/json

Endpoint: https://${Cloud Domain}/cgi/crm/v2/data/query?thirdTraceId=${Random String}

Headers: Refer to Common Parameters

Request Parameters

Parameter	Type	Required	Description
returnTotalNum	Int	No	Total count type, 1: return the exact total, 2: return an estimated total, 3 or not provided: do not return the total (faster response)
includeNull	Boolean	No	Whether to include null fields, false: not returned, true: returned, defaults to false if not provided
data	Map	Yes	Data map
dataObjectApiName	String	Yes	Object api_name, fixed value: KnowledgeCategoryObj
search_query_info	Map	Yes	Query conditions
limit	Int	Yes	Page size (maximum 100)
offset	Int	Yes	Offset (starts from 0, must be an integer multiple of limit)
filters	List	Yes	Filter condition list
field_name	String	Yes	Field name
field_values	List[String]	Yes	Field value
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: ascending, false: descending)
fieldProjection	List[String]	Yes	Return fields (use the apiName of the object fields)

operator Parameter Description

You can directly use query conditions from the object list page, see How to get query conditions from the list

Parameter	Meaning	Description	Parameter	Meaning	Description
EQ	Equals		N	Not equals	Can query null values
GT	Greater than		GTE	Greater than or equal
LT	Less than		LTE	Less than or equal
LIKE	Contains		NLIKE	Does not contain
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 overlapping elements		NHASANYOF	No overlap

Request Example

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

Response Parameters

Parameter	Type	Description
data	Map	For detailed parameter information, call the Query Object Description interface
traceId	string	Unique request ID
errorDescription	string	Error description
errorMessage	string	Error message
errorCode	Int	Error Codes

Response Example

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

Notes

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