【API操作】明道云API筛选介绍与快速取值方案

产品 零代码明道云API  收藏
3 / 1294

随着客户深入使用明道云,与数据的供给第三方集成或显示。工作表的 API 被越来越多的客户使用。数据对外是需要提取筛选有效数据。API 接口筛选器已经开放出来。但是对于使用赋值,大多客户却是一头雾水。
  小编这里就讲解下筛选器的字段说明以及快速取值方案。(快速取值方案不需要了解字段具体的含义,小白直接上手使用 😄 )

筛选器

参数 必填 类型 说明
controlId string 控件 ID
dataType number 控件类型编号
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 bool 是否升序(false:降序)
示例
"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 自定义

特殊 AccountID

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

DataType 就是控件类型 ControlType

public enum ControlType
   {
       /// <summary>
       /// 单行文本
       /// </summary>
       [Description("文本框")]
       Text =1,
       /// <summary>
       /// 多行文本
       /// </summary>
       [Description("文本框")]
       TextArea =2,
       /// <summary>
       /// 手机号
       /// </summary>
       [Description("手机")]
       MobilePhone =3,
       /// <summary>
       /// 座机号
       /// </summary>
       [Description("座机")]
       Landline =4,
       /// <summary>
       /// 电子邮箱
       /// </summary>
       [Description("邮件地址")]
       Email =5,
       /// <summary>
       /// 数值
       /// </summary>
       [Description("数值")]
       Number = 6,
       /// <summary>
       /// 证件
       /// </summary>
       [Description("证件")]
       Certificates =7,
       /// <summary>
       /// 金额
       /// </summary>
       [Description("金额")]
       Amount =8,
       /// <summary>
       /// 单选框
       /// </summary>
       [Description("单选")]
       Radio =9,
       /// <summary>
       /// 多选框
       /// </summary>
       [Description("多选")]
       CheckBox =10,
       /// <summary>
       /// 下拉框
       /// </summary>
       [Description("单选")]
       Select =11,
       /// <summary>
       /// 人员单
       /// </summary>
       [Description("成员")]
       Personnel = 12,
       /// <summary>
       /// 人员多
       /// </summary>
       [Description("成员")]
       People =13,
       /// <summary>
       /// 附件
       /// </summary>
       [Description("附件")]
       Attachment =14,
       /// <summary>
       /// 日期
       /// </summary>
       [Description("日期")]
       Date =15,
       /// <summary>
       /// 日期时间
       /// </summary>
       [Description("日期和时间")]
       DateTime =16,
       /// <summary>
       /// 日期段
       /// </summary>
       [Description("日期段")]
       DateSpan =17,
       /// <summary>
       /// 日期时间段
       /// </summary>
       [Description("日期时间段")]
       DateTimeSpan =18,
       /// <summary>
       /// 地区(省)
       /// </summary>
       [Description("地区(省)")]
       District1 = 19,
       /// <summary>
       /// 公式
       /// </summary>
       [Description("公式")]
       Formula =20,
       /// <summary>
       /// 关联到
       /// </summary>
       [Description("自由连接")]
       Relation = 21,
       /// <summary>
       /// 分割线(无编辑行为)
       /// </summary>
       [Description("分段")]
       SplitLine =22,
       /// <summary>
       /// 地区(省市)
       /// </summary>
       [Description("地区(省-市)")]
       District2 = 23,
       /// <summary>
       /// 地区(省市县)
       /// </summary>
       [Description("地区(省-市-县)")]
       District3 = 24,

       /// <summary>
       /// 大写金额
       /// </summary>
       [Description("大写金额")]
       BigAmount = 25,

       /// <summary>
       /// 人员选择
       /// </summary>
       [Description("成员")]
       UserSelect = 26,

       /// <summary>
       /// 部门选择
       /// </summary>
       [Description("部门")]
       DepartmentSelect = 27,

       /// <summary>
       /// 评分控件
       /// </summary>
       [Description("等级")]
       Score =28,

       /// <summary>
       /// 连接他表
       /// </summary>
       [Description("表关联")]
       RelationWorksheet = 29,

       /// <summary>
       /// 他表字段
       /// </summary>
       [Description("关联表字段")]
       RelationWSColumn = 30,

       /// <summary>
       /// 工作表公式(其他模块可调用)
       /// </summary>
       [Description("公式")]
       WSFormula = 31,

       /// <summary>
       /// 文本拼接
       /// </summary>
       [Description("文本组合")]
       FormulaString = 32,

       /// <summary>
       /// 自动编号
       /// </summary>
       [Description("自动编号")]
       Increase = 33,

       /// <summary>
       /// 子表
       /// </summary>
       [Description("子表")]
       DetailTable = 34,

       /// <summary>
       /// 级联选择
       /// </summary>
       [Description("级联选择")]
       Cascade = 35,

       /// <summary>
       /// 检查框
       /// </summary>
       [Description("检查框")]
       CheckRadio = 36,

       [Description("汇总")]
       Summary = 37,

       [Description("公式(日期)")]
       FormulaDate = 38,

       [Description("扫码")]
       ScanCode = 39,

       [Description("定位")]
       Location = 40,

       [Description("富文本")]
       RichText = 41,

       [Description("签名")]
       Signature = 42,

       //////////////////////////////////////以下放只读控件////////////////////////////////////////////////////
       /// <summary>
       /// 申请人
       /// </summary>
       RO_Applicant =10001,
       /// <summary>
       /// 申请日期
       /// </summary>
       RO_ApplyDate =10002,
       /// <summary>
       /// 所属部门
       /// </summary>
       RO_Department =10003,
       /// <summary>
       /// 职位
       /// </summary>
       RO_Position = 10004,
       /// <summary>
       /// 工作地点
       /// </summary>
       RO_WorkPlace =10005,
       /// <summary>
       /// 公司
       /// </summary>
       RO_Company =10006,
       /// <summary>
       /// 工作电话
       /// </summary>
       RO_WorkPhone=10007,
       /// <summary>
       /// 移动电话
       /// </summary>
       RO_MobilePhone =10008,
       /// <summary>
       /// 工号
       /// </summary>
       RO_JobNumber =10009,
       /// <summary>
       /// 备注
       /// </summary>
       [Description("备注")]
       RO_Remark = 10010,

   }

有一些用不到 ,用到的有:2,3,4,5,6,7,8,9,10,11,14,15,16,19,23,24,26,27,28,29,30,31,32,33,34,35,36,37,38

快速取值方案

浏览器 F12 找到 Network --> 点击 XHR--》找到 GetFilterRows--> 点击--> 点击【Header】--> 找到 Request Payload 展开 --> 复制出 filterControls 的内容--> 放到 API 筛选器的 filters 中。具体步骤如下图:
image.png

明道云
工作表 API