描述

查询自定义对象列表

请求说明

请求方式 ：POST + application/json

请求路径 ：https://${填入所在云的域名}/cgi/crm/custom/v2/data/query?thirdTraceId=${随机字符串}

请求头填写 ：参考公共参数填写

本接口只适用于自定义对象（即对象的ApiName以__c结尾的对象）

请求参数

参数	类型	是否必填	说明
includeNull	Boolean	否	是否包含 null 字段,false:不返回,true:返回，不传默认为false
data	Map	是	数据map
dataObjectApiName	String	是	对象的api_name，固定取值：DeliveryNoteProductObj
find_explicit_total_num	String	否	是否返回总数(true:返回total总数,false:不返回total总数（默认true。设置为false可以加快接口响应速度）)
search_query_info	String	是	查询条件
limit	Int	是	分页条数(最大值为100)
offset	Int	是	偏移量(从0开始、数值必须为limit的整数倍)
filters	List	是	过滤条件列表
field_name	String	是	字段名
field_values	List	是	字段值
operator	String	是	操作符
orders	List	是	排序
fieldName	String	是	字段名
isAsc	Boolean	是	是否升序(如果是true，按照升序排列，如果是false，则按照倒序排列)

请求示例

{
  "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": ""
  }
}

返回参数

参数	类型	说明
traceId	string	请求唯一ID
errorDescription	string	错误描述
errorMessage	string	错误信息
errorCode	Int	查看错误码

返回示例

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

注意事项

• 不能使用返回值的message字段做逻辑判断，errorMessage会有变化;

特殊说明

operator参数说明

参数	参数含义	参数	参数含义
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 包含