筛选器使用指南 (V2)

API V2 使用基于枚举值的筛选器语法。

筛选器参数

参数	必填	类型	说明
controlId	是	string	字段ID
dataType	是	number	控件类型编号，枚举值DataTypeEnum 请参考字段类型
spliceType	是	number	拼接方式，1:And 2:Or
filterType	是	number	筛选类型，枚举值FilterTypeEnum 请参考下表
values	否	list[string]	根据筛选类型，传多个值，传特殊AccountID请参考下表
value	否	string	根据筛选类型，传单个值，传特殊AccountID请参考下表
dateRange	否	number	日期范围，枚举值DateRangeEnum 请参考下表
dateRangeType	否	number	日期范围类型，1：天 2：周 3：月 4：季 5：年
minValue	否	string	最小值
maxValue	否	string	最大值
isAsc	否	boolean	是否升序（false：降序）
isGroup	否	boolean	当前筛选条件是否是筛选组，为true时需要传 groupFilters 参数，只支持一层筛选组
groupFilters	否	list[object]	筛选组列表，对象为筛选器对象

请求示例

{
  "controlId": "ordernumber",
  "dataType": 6,
  "spliceType": 1,
  "filterType": 13,
  "value": "2"
}

FilterTypeEnum（筛选类型枚举）

枚举值	枚举字符	说明
0	Default
1	Like	包含
2	Eq	是（等于）
3	Start	开头为
4	End	结尾为
5	NContain	不包含
6	Ne	不是（不等于）
7	IsNull	为空
8	HasValue	不为空
11	Between	在范围内
12	NBetween	不在范围内
13	Gt	>
14	Gte	>=
15	Lt	<
16	Lte	<=
17	DateEnum	日期是
18	NDateEnum	日期不是
21	MySelf	我拥有的
22	UnRead	未读
23	Sub	下属
24	RCEq	关联控件是
25	RCNe	关联控件不是
26	ArrEq	数组等于
27	ArrNe	数组不等于
31	DateBetween	在范围内
32	DateNBetween	不在范围内
33	DateGt	>
34	DateGte	>=
35	DateLt	<
36	DateLte	<=
41	NormalUser	常规用户
42	PortalUser	外部门户用户

DateRangeEnum（日期范围枚举）

枚举值	枚举字符	说明
0	Default
1	Today	今天
2	Yesterday	昨天
3	Tomorrow	明天
4	ThisWeek	本周
5	LastWeek	上周
6	NextWeek	下周
7	ThisMonth	本月
8	LastMonth	上月
9	NextMonth	下月
10	LastEnum	上..
11	NextEnum	下..
12	ThisQuarter	本季度
13	LastQuarter	上季度
14	NextQuarter	下季度
15	ThisYear	本年
16	LastYear	去年
17	NextYear	明年
18	Customize	自定义
21	Last7Day	过去7天
22	Last14Day	过去14天
23	Last30Day	过去30天
31	Next7Day	未来7天
32	Next14Day	未来14天
33	Next33Day	未来33天

特殊 AccountID

ID	说明
user-self	当前用户
user-sub	下属
user-workflow	工作流
user-api	API

筛选组示例

支持一层筛选组：

{
  "controlId": "field1",
  "dataType": 2,
  "spliceType": 1,
  "filterType": 1,
  "value": "test",
  "isGroup": true,
  "groupFilters": [
    {
      "controlId": "field2",
      "dataType": 6,
      "spliceType": 1,
      "filterType": 13,
      "value": "10"
    },
    {
      "controlId": "field3",
      "dataType": 6,
      "spliceType": 2,
      "filterType": 15,
      "value": "100"
    }
  ]
}

注意事项

• 筛选组限制: 只支持一层筛选组
• 拼接方式: spliceType 1表示AND，2表示OR
• 日期筛选: 使用日期相关筛选类型时，可以配合 dateRange 和 dateRangeType 使用
• 数组值: 某些筛选类型需要使用 values 数组而不是 value 单个值

相关文档

• API V2 行记录接口 - 使用筛选器查询记录
• 字段类型对照表 - DataTypeEnum 枚举值

---

维护负责人：技术部
最后更新：2025-01-19