查询DSL说明

本文介绍客户、联系人、跟进记录、自定义对象的查询DSL语法。

DSL语法的介绍

客户管理部分接口，需要传入查询queryDsl来查询结果。例如以下接口：

类别	接口列表
客户	根据指定条件查询个人或企业客户数据
联系人	根据指定条件查询联系人数据
跟进记录	根据指定条件查询跟进记录数据
自定义对象	根据指定条件查询自定义对象数据

DSL语法的格式

queryDsl由以下两部分组成：

查询条件列表

排序字段

DSL语法包括查询条件列表、排序字段。

{
 "queryGroupList": [{
  "logicType": "AND", //查询条件之间的拼接方式，取值：AND/OR
  "queryObjectList": [{
   "filterType": "IN", //字段查询类型
   "fieldId": "principal", //查询字段名
   "value": ["2050193136694677"] //查询字段值
  }]
 }],
 "order": "DESC", //排序方式，取值：DESC/ASC
 "orderFieldId": "gmt_create" //排序字段名，如果没有指定则默认使用gmt_create
}

查询条件列表

字段是queryGroupList。

字段	说明
logicType	多个查询条件之间的拼接方式，取值：AND/OR。
queryObjectList	多个查询条件。
filterType	查询类型，支持以下取值：SEARCH：模糊搜索EQ：值相等IN：等同于SQL中的INBETWEEN：介于，使用该过滤类型时，value值格式为数组。
value	查询字段的值，根据filterType取值需要传入不同格式的value：SEARCH：文本，比如："公司"EQ：文本，比如："公司"IN：JSON数组格式，比如：["2050193136694677"]BETWEEN：介于，使用该过滤类型时，value值格式为JSON数组，比如：["1636473600000", "1636646399999"]。
fieldId	客户：过滤字段名，支持传入两种字段类型：表单字段：通过调用获取个人或企业客户的元数据接口，获取字段列表fields下的字段名称name系统字段：gmt_create：创建时间gmt_modified：更新时间principal：负责人participant：协同人
联系人：过滤字段名，支持传入两种字段类型：表单字段：通过调用获取联系人的元数据接口，获取字段列表fields下的字段名称name。系统字段：gmt_create：创建时间gmt_modified：更新时间principal：负责人participant：协同人
跟进记录：过滤字段名，支持传入两种字段类型：表单字段：通过调用获取跟进记录对象的元数据接口，获取字段列表fields下的字段名称name。系统字段：gmt_create：创建时间gmt_modified：更新时间principal：负责人participant：协同人
自定义对象：过滤字段名，支持传入两种字段类型：表单字段：通过调用获取自定义对象的元数据接口，获取字段列表fields下的字段名称name。系统字段：gmt_create：创建时间gmt_modified：更新时间principal：负责人participant：协同人

排序条件

字段	说明
orderFieldId	排序字段名。重要只支持gmt_create（创建时间）、gmt_modified（更新时间）。
order	排序方式，支持以下取值：ASC：升序DESC：降序

使用示例

根据负责人查询数据并根据创建时间降序排序

{
 "queryGroupList": [{
  "logicType": "AND",
  "queryObjectList": [{
   "filterType": "IN",
   "value": ["2050193136694677"],
   "fieldId": "principal"
  }]
 }],
 "order": "DESC",
 "orderFieldId": "gmt_create"
}

查询客户跟进状态为待跟进的数据（单选、多选控件）

{
 "queryGroupList": [{
  "logicType": "AND",
  {
   "filterType": "IN",
   "value": ["待跟进"],
   "fieldId": "DDSelectField-KI5S975E"
  }]
 }]
}

根据客户标签筛选数据

{
 "queryGroupList": [{
  "logicType": "AND",
  "queryObjectList": [{
   "filterType": "IN",
   "value": ["待邀约"],
   "fieldId": "MultiTagField-58e38fd7"
  }]
 }]
}

搜索客户名称为XX的数据（文本控件、地址控件）

{
 "queryGroupList": [{
  "logicType": "AND",
  "queryObjectList": [{
   "filterType": "SEARCH",
   "value": "XX",
   "fieldId": "TextField-K2U5DHAA"
  }]
 }]
}

根据创建时间筛选数据(日期控件、数字控件范围查询)

{
 "queryGroupList": [{
  "logicType": "AND",
  "queryObjectList": [{
   "filterType": "BETWEEN",
   "value": ["1636473600000", "1636646399999"],
   "fieldId": "gmt_create"
  }]
 }]
}

多条件组合查询

{
 "queryGroupList": [{
  "logicType": "AND",
  "queryObjectList": [{
   "filterType": "BETWEEN",
   "value": ["1636473600000", "1636646399999"],
   "fieldId": "gmt_create"
  },{
   "filterType": "SEARCH",
   "value": "a",
   "fieldId": "DDTextField-xxx"
  }]
 }]
}

DSL语法的介绍#

DSL语法的格式#

查询条件列表#

排序条件#

使用示例#

根据负责人查询数据并根据创建时间降序排序#

查询客户跟进状态为待跟进的数据（单选、多选控件）#

根据客户标签筛选数据#

搜索客户名称为XX的数据（文本控件、地址控件）#

根据创建时间筛选数据(日期控件、数字控件范围查询)#

多条件组合查询#

DSL语法的介绍

DSL语法的格式

查询条件列表

排序条件

使用示例

根据负责人查询数据并根据创建时间降序排序

查询客户跟进状态为待跟进的数据（单选、多选控件）

根据客户标签筛选数据

搜索客户名称为XX的数据（文本控件、地址控件）

根据创建时间筛选数据(日期控件、数字控件范围查询)

多条件组合查询