数据结构

一篇多维表格可以理解成是一个 app，他的唯一标识就是 app_token。

app 是由一个个 table 组成，我们称 table 为数据表，他的标识就是 table_id。

table 由 record(记录) 和 field(字段) 组成, 同时可以拥有多个 view (视图)。

记录

记录由 record 和 fields 2个结构组成。

record结构

记录是一个object结构类型。

参数	数据结构	描述
`record_id`	string	记录的id
`fields`	map	记录的字段

fields结构

fields是一个map，是由字段名和其具体内容的键值对组成。

item	datatype	description
`key`	`string`	字段名
`value`	`union`	某个字段的具体内容，其结构可以是string, boolean, list of string and list of person object

value结构(不同字段类型对应值的结构)

字段类型	value结构	描述
多行文本	string	值
数字	写入时为number，列出时为string	值
单选	string	选项名称
多选	array	包含多个选项名字符串的数组
日期	number	Unix 时间戳，单位是毫秒
复选框	boolean	布尔值
人员	object	具体结构参考: 人员
电话号码	string	电话号码，符合正则表达式`(\+)?\d*`的字符串
超链接	object	具体结构参考: 超链接
附件	object	具体结构参考: 附件
单向关联	array	包含多个 record_id 字符串的数组
双向关联	-	只支持列出，暂不支持写入
创建时间	number	Unix 时间戳，单位是毫秒
最后更新时间	number	Unix 时间戳，单位是毫秒
创建人	object	具体结构参考: 人员
修改人	object	具体结构参考: 人员
自动编号	string	由自动编号规则组成的字符串
地理位置	object	具体结构参考: 地理位置

人员

参数	数据结构	描述
`name`	string	名字
`id`	string	id
`en_name`	string	英文名字
`email`	string	邮箱

超链接

参数	数据结构	描述
`text`	string	文本名称
`link`	string	超链接

附件

参数	数据结构	描述
`file_token`	string	附件token
`name`	string	附件名称
`type`	string	附件的 mime 类型, 如: `image/png`
`size`	int	附件大小, 单位: 字节
`url`	string	附件url，下载请参考:下载附件
`tmp_url`	string	生成附件临时下载链接的url，需access token鉴权

地理位置

参数	数据结构	描述
`location`	string	经纬度
`pname`	string	省
`cityname`	string	市
`adname`	string	区
`address`	string	详细地址
`name`	string	地名
`full_address`	string	完整地址

字段

字段是一个object结构类型。

名称	类型	描述
field_id	string	字段id
field_name	string	字段名
type	int	字段类型： 1：多行文本 2：数字 3：单选 4：多选 5：日期 7：复选框 11：人员 13：电话号码 15：超链接 17：附件 18：单向关联 19：查找引用 20：公式 21：双向关联 22：地理位置 1001：创建时间 1002：最后更新时间 1003：创建人 1004：修改人 1005：自动编号
property	object	字段属性，因字段类型而异

Property说明

参考: 字段编辑指南

视图

视图是一个object结构类型。

item	datatype	description
`view_id`	`string`	视图id
`view_name`	`string`	视图名称
`view_type`	`string`	视图类型，支持grid, kanban, gallery, gantt四种类型，默认为grid类型

自定义数据结构

delete_record

参数	数据类型	描述
`deleted`	`boolean`	是否删除成功
`record_id`	`string`	单条记录的id

记录#

record结构#

fields结构#

value结构(不同字段类型对应值的结构)#

人员#

超链接#

附件#

地理位置#

字段#

Property说明#

视图#

自定义数据结构#

delete_record#

记录