附录

附录 1：数据表字段类型说明

字段类型	Type	创建字段格式	设置字段值传入形式	读取字段值传出形式
多行文本	MultiLineText	无特殊要求	字符串/ 无特殊格式要求	字符串
日期	Date	无特殊要求	字符串/ `yyyy/mm/dd`	字符串
时间	Time	无特殊要求	字符串/ `hh:mm:ss`	字符串
数值	Number	无特殊要求	数值 / 无格式	数值
货币	Currency	无特殊要求	数值 / 无格式	数值
百分比	Percentage	无特殊要求	数值 / 无格式	数值
身份证	ID	无特殊要求	字符串 / 符合身份证规则	字符串
电话	Phone	无特殊要求	字符串 / 符合电话规则	字符串
电子邮箱	Email	无特殊要求	字符串 / 符合邮箱规则	字符串
超链接	Url	可以额外传入一个参数。`displayText`：指定超链接显示文本。`{"name":"超链接","type":"Url","displayText":"跳转"}`	字符串 / 符合 Url 规	字符串
复选框	Checkbox	无特殊要求	true / false	布尔
单选项	SingleSelect	需要额外传入选项值，至少一个。`{"name": "单选项","type": "SingleSelect","items": [{ "value": "item1" }]}`	字符串 / 匹配选项内容	字符串
多选项	MultipleSelect	需要额外传入选项值，至少一个。`{"name": "单选项","type": "SingleSelect","items": [{ "value": "item1" }, { "value": "item2" }]}`	字符串数组 / 匹配选项内容	字符串数组
等级	Rating	需要额外传入一个最大等级, 最大等级大于 0 小于等于 5。`{"name": "等级","type": "Rating","max": 5}`	数值 / 大于 0 并且小于最大等级	数值
进度条	Complete	无特殊要求	数值 / 大于等于 0 并且小于 100	字符串
联系人	Contact	需要额外传入两个参数： multipleContacts: `<bool>` 是否支持多个联系人 noticeNewContact: `<bool>` 是否通知联系人。 `{"name": "联系人","type": "Contact","multipleContacts": false,"noticeNewContact": false}`	不支持设值	对象
附件	Attachment	无特殊要求	不支持设值	对象
关联	Link	需要额外传入二个参数： linkSheet: 关联表 ID multipleLinks: 是否关联多条记录 `{"name": "联系人","type": "Link","multipleContacts": false,"noticeNewContact": false}`	对应关联表的行记录数组
富文本	Note	无特殊要求	不支持设值	对象
编号	AutoNumber	无特殊要求	不支持设值	数值
创建者	CreatedBy	无特殊要求	不支持设值	对象
创建时间	CreatedTime	无特殊要求	不支持设值	字符串
公式	Formula	无特殊要求	不支持设值	根据公式的值类型
引用	Lookup	无特殊要求	不支持设值	与被引用形式相同

附录 2：数据表视图类型说明

视图类型	说明
Grid	表格视图
Kanban	看板视图
Gallery	画册视图
Form	表单视图
Gantt	甘特视图

附录 3：筛选条件说明

筛选条件用来对行记录进行筛选，由两部分构成：mode 为筛选条件关系；creteria 为具体筛选条件（fileds op values）。

json

{
  "mode": "AND", // 选填。表示各筛选条件之间的逻辑关系。只能是"AND"或"OR"。缺省值为"AND"
  "criteria": [
    // filter结构体内必填。包含筛选条件的数组。每个字段上只能有一个筛选条件
    {
      "field": "名称", // 必填。根据 preferId 与否，需要填入字段名或字段id
      "op": "Intersected", // 必填。表示具体的筛选规则，见下
      "values": [
        // 必填。表示筛选规则中的值。数组形式。
        "数据表", // 值为字符串时表示文本匹配
        "12345"
      ]
    },
    {
      "field": "数量",
      "op": "Greater",
      "values": ["1"]
    }
  ]
}

筛选条件	参数说明
Equals	等于
NotEqu	不等于
Greater	大于
GreaterEqu	大等于
Less	小于
LessEqu	小等于
GreaterEquAndLessEqu	介于（取等）
LessOrGreater	介于（不取等）
BeginWith	开头是
EndWith	结尾是
Contains	包含
NotContains	不包含
Intersected	指定值
Empty	为空
NotEmpty	不为空

各筛选规则独立地限制了 values 数组内最多允许填写的元素数，当 values 内元素数超过阈值时，该筛选规则将失效。

为空、不为空不允许填写元素；介于允许最多填写 2 个元素；指定值允许填写 65535 个元素；其他规则允许最多填写 1 个元素。

注意

filter 不是结构体，当 criteria 未指定 field、op/values 参数填写不合法、values 填写过多参数及其他可能导致筛选规则失效等情形，整个请求将直接失败。

目前还支持对日期进行动态筛选，此时 values[]内的元素需以结构体的形式给出：

json

{
  "mode": "AND",
  "criteria": [
    {
      "field": "日期",
      "op": "Equals",
      "values": [
        {
          "dynamicType": "lastMonth",
          "type": "DynamicSimple"
        }
      ]
    }
  ]
}

提示

上述示例对应的筛选条件为等于上一个月。

要使用日期动态筛选，values[]内的结构体需要指定type为DynamicSimple，当op为Equals时，dynamicType可以为如下的值（大小写不敏感）。

字段	说明
today	今天
yesterday	昨天
tomorrow	明天
last7Days	最近 7 天
last30Days	最近 30 天
thisWeek	本周
lastWeek	上周
nextWeek	下周
thisMonth	本月
lastMonth	上月
nextMonth	次月

提示

当op为greater或less时，dynamicType只能是昨天、今天或明天。

附录 ​

附录 1：数据表字段类型说明 ​

附录 2：数据表视图类型说明 ​

附录 3：筛选条件说明 ​

附录

附录 1：数据表字段类型说明

附录 2：数据表视图类型说明

附录 3：筛选条件说明