数据模型及参数说明手 册
常用参数
workspaceId
每一#空间都有对应的空间 ID(即 workspaceId)。获取 workspaceId 的方式很简单:
打开任意一张数据表,在 URL 地址栏中找到以 wsp 开头的一段字符串,这便是这个空间的 workspaceId 了。
applicationId
每一个应用都有对应的应用 ID(即 applicationId)。获取 applicationId 的方式很简单:
打开任意一张数据表,在 URL 地址栏中找到以 app 开头的一段字符串,这便是这个应用的 applicationId 了。
tableId
每一个数据表都有对应的表 ID(即 tableId)。获取 tableId 的方式很简单:
打开任意一张数据表,在 URL 地址栏中找到以 tb 开头的一段字符串,这便是这个数据表的 tableId了。
viewId
每一个视图都有对应的视图 ID(即 viewId)。获取 viewId 的方式很简单:
选中任意一张数据表的视图,在 URL 地址栏中找到以 viw 开头的一段字符串,这便是这个视图的 viewId了。
rowId
数据表中的每一行都对应着一个唯一的行 ID(即 rowId),获取 rowId 的方式需要通过 API 请求获得。
columnId
数据表中表头是列信息组成的,描述每一列数据的类型和配置,且每一列的都对应着一个唯一的列 ID(即 columnId),获取 columnId 的方式需要通过 API 请求获得。
commentId
数据表中的每一行都对应着若干条评论,每一条评论都对应着唯一的评论 ID(即 commentId),获取 columnId 的方式需要通过 API 请求获得。
常用数据模型
列类型
对应着表中的表头,有不同的类型用来规范表中的数据,API 已支持的类型如下:
列类型 | 说明 | 数据类型 | 特殊说明 | 是否已支持 |
---|---|---|---|---|
SINGLE_LINE_TEXT | 单行文本 | string | 任意字符串 | ✔ |
MULTILINE_TEXT | 多行文本 | string | 任意字符串 | ✔ |
URL | 链接 | string | 任意字符串 | ✔ |
MULTIPLE_ATTACHMENTS | 附件 | string[] | 数组类型,元素只能是通过 WeMore 上传后的 URL 字符串 | |
SINGLE_SELECT | 单选 | string | 只是选项显示值 | |
MULTIPLE_SELECTS | 多选 | string[] | 数组类型,元素只是选项显示值 | |
NUMBER | 数字 | number | 任意数字 | ✔ |
CURRENCY | 货币 | number | 任意数字 | ✔ |
AUTO_NUMBER | 自增列 | number | 不可修改,服务端返回的数字 | ✔ |
CHECK_BOX | 复选框 | boolean | 只能是 true 或者 false | ✔ |
REF_ROW | 关联行 | string[] | 数组类型,元素只能填入正确的 rowId | ✔ |
REF_COLUMN | 引用列 | any[] | 不可修改,服务端返回,数组内元素需要根据实际引用类型确定 | |
MULTIPLE_COLLABORATORS | 成员/部门 | json[] | 数组类型,元素且只能是一种特殊数据模型,后续介绍 | ✔ |
CREATED_BY | 创建人 | number | 不可修改,服务端返回的数字,为成员ID | ✔ |
LAST_MODIFIED_BY | 最后修改人 | string | 不可修改,服务端返回的数字,为成员ID | |
DATE_TIME | 日期时间 | number | 只能是毫秒时间戳 | ✔ |
CREATED_TIME | 创建时间 | number 毫秒时间戳 | 不可修改,服务端返回的数字,为毫秒时间戳 | ✔ |
LAST_MODIFIED_TIME | 最后修改时间 | number 毫秒时间戳 | 不可修改,服务端返回的数字,为毫秒时间戳 |
成员/部门模型
id 为 number 类型,type 值只可能为 MEMBER 或者 DEPT。
比如以下是一个成员,在通讯录中的 id 为 958。
{"id": 958, "type": "MEMBER"}
比如以下是一个部门,在通讯录中的 id 为 26。
{"id": 26, "type": "DEPT"}
非空行示例:
"rowData": {
"name": "我的list",
"ownerId": 789,
"createdTime": 1638952698087
}
注意,列对应的单元格值为空时,其不一定会出现在 json 中。
公式相关
公式 | 说明 |
---|---|
= | 等于 |
!= | 不等于 |
> | 大于 |
< | 小于 |
>= | 大于等于 |
<= | 小于等于 |
CONTAINS | 包含 |
NOT_CONTAINS | 不包含 |
ANY | 存在任一,用于 多选项 及数组类型的筛选 |
字段筛选示例::
字段类型 | 字段筛选 |
---|---|
单行文本/多行文本 | {col1} = 'a' 或者 CONTAINS({col1}, '张三') |
数字/货币/自增列 | {col1} = 100 或者 AND({col1} >= 0.9, {col2} != 100) |
关联表 | CONTAINS({col1}, 'rowId')) |
复选框 | 直接使用字段 {col1} 或者 {col1} = TURE() |
成员部门/创建人/最后修改人 | CONTAINS({col1}, '{"id": 958, "type": "MEMBER"}')) 或者 ANY({col1}, '{"id": 958, "type": "MEMBER"}', '{"id": 26, "type": "DEPT"}') |
日期时间/创建时间/最后修改时间 | IS_BEFORE({col1}, '2021-01-01')) 或者 IS_AFTER({col1}, '2022-12-12 11:11:11') |