Skip to content

多维表格概述

多维表格(Base)是全新的业务管理工具,帮助用户重构工作应用和团队协同模式,高效在线协同数据,随心构建个性化应用,轻松掌控全盘业务数据,和团队一起创造效率的无限可能。多维表格可以是一个表格,也可以是无数个应用。它拥有强大的底层开放能力,你可以通过多维表格 API 轻松打通内部其他业务系统,让业务数据通畅流转,实时同步。

典型案例

开放平台提供了集成多维表格能力的客户实践案例:

接入流程

接入多维表格 OpenAPI 的流程如下图所示。了解更多,参考云文档概述接入流程 一节。

开发教程

体验以下多维表格相关教程,了解如何运用多维表格 API 助力企业高效协作。

鉴权说明

使用 tenant_access_token 访问多维表格资源之前,请确保你的应用已经是多维表格的所有者或者协作者,否则会调用失败。 你可通过添加文档应用的方式将应用添加为协作者,详情参考开通文档、电子表格等其它云文档资源权限;或通过应用身份创建一篇多维表格,再使用 tenant_access_token 来调用接口。

使用限制

使用多维表格接口,整体有以下限制或说明:

  • 对于接口的批量操作,单次最高为 1,000 条记录,且响应状态是全部成功或者失败,不存在部分成功或失败的结果。
  • 为保证稳定性,建议对单一多维表格同时只请求一次 API 写操作。 单一多维表格中,各个资源的数量限制如下所示:
资源最大支持数量
记录不同租户的最大支持数量不同,开放平台没有额外限制。你可以在多维表格数据表 UI 中点击查看。 image.png
字段300,对于公式类型的字段,最多支持 100 个
视图200
数据表+仪表盘100
高级权限自定义角色30
高级权限协作者200

资源介绍

多维表格开放了多维表格 App、数据表、视图、记录、字段、仪表盘、高级权限等多种资源的接口。本小节介绍这几类资源的含义。了解更多多维表格的概念和使用说明,可参考飞书帮助中心文档快速上手多维表格

多维表格 app

一个多维表格可以理解成是一个应用(app,但不是在开发者后台创建的应用),标记该应用的唯一标识为 app_token。作为一个应用,多维表格有多种形态:可以作为一个独立应用,也可以作为一个模块(block)与文档、电子表格结合。

多维表格形态

多维表格形态资源定义含义
文件夹中的多维表格Base app存储在飞书云空间(云盘)文件夹中的多维表格。URL 以 feishu.cn/base 开头
知识库下的多维表格Base app 和 wiki node放置在知识库中的多维表格。URL 以 feishu.cn/wiki 开头
文档嵌入多维表格Base docx block即在"文档"中插入的多维表格,URL 以 feishu.cn/docx 开头
电子表格嵌入多维表格Base sheet block在电子表格中嵌入的多维表格,URL 以 feishu.cn/sheets 开头

多维表格 app_token 获取方式

不同形态的多维表格,其 app_token 的获取方式不同,具体如下所示。

文件夹中的多维表格

该类多维表格的 app_token 为 URL 下图高亮部分:

知识库下的多维表格

需调用知识库相关获取知识空间节点信息接口获取该类多维表格的 app_token。如下返回示例,当 obj_type 的值为 bitable 时,obj_token 字段的值 AW3Qbtr2cakCnesXzXVbbsrIcVT 是多维表格的 app_token

json
{
    "node":{
        "space_id":"6946843325487912356",
        "node_token":"wikcnKQ1k3p******8Vabcef",
        "obj_token":"AW3Qbtr2cakCnesXzXVbbsrIcVT",  // 多维表格的 app_token
        "obj_type":"bitable",
        "parent_node_token":"wikcnKQ1k3p******8Vabcef",
        "node_type":"origin",
        "origin_node_token":"wikcnKQ1k3p******8Vabcef",
        "origin_space_id":"6946843325487912356",
        "has_child":false,
        "title":"标题",
        "obj_create_time":"1642402428",
        "obj_edit_time":"1642402428",
        "node_create_time":"1642402428",
        "creator":"ou_xxxxx",
        "owner":"ou_xxxxx"
    }
}
文档嵌入多维表格

文档中嵌入的多维表格,需要调用文档相关接口获取多维表格的 app_token。 调用获取文档所有块,在返回结果中检索,其中 bitable.token 字段的值 AW3Qbtr2cakCnesXzXVbbsrIcVT_tblkIYhz52o6G5nx是用 _ 隔开的 app_tokentable_id

json
{
  "bitable": {
    "token": "AW3Qbtr2cakCnesXzXVbbsrIcVT_tblkIYhz52o6G5nx"
  },
  "block_id": "Mgeadqo4CoeoOGxI7Lgb4GNicEd",
  "block_type": 18,
  "parent_id": "YUqpdO2eLo7xJdxy5RQbuQBdctf"
}
电子表格嵌入多维表格

电子表格中嵌入的多维表格,需要调用电子表格相关接口获取多维表格的 app_token。 若电子表格中嵌有多维表格,需调用获取表格元数据,在返回结果中将返回 blockInfo。其中,当 blockType 的值为 BITABLE_BLOCK 时,blockToken 字段的值AW3Qbtr2cakCnesXzXVbbsrIcVT_tblkIYhz52o6G5nx 是用 _ 隔开的 app_tokentable_id

json
{
  "blockInfo": {
    "blockToken": "AW3Qbtr2cakCnesXzXVbbsrIcVT_tblkIYhz52o6G5nx",
    "blockType": "BITABLE_BLOCK"
  },
  "columnCount": 0,
  "frozenColCount": 0,
  "frozenRowCount": 0,
  "index": 0,
  "rowCount": 0,
  "sheetId": "***",
  "title": "*** "
}

数据表 table

多维表格的数据容器,一个多维表格中至少有一个数据表(table),也可能有多个数据表。每个数据表都有唯一标识 table_idtable_id 在一个多维表格 App 中唯一,在全局不一定唯一。 你可通过多维表格 URL 获取 table_id,下图高亮部分即为当前数据表的唯一标识。你也可通过列出数据表接口获取 table_id

视图 view

指数据的汇总和展现形式。视图有多种类型,包括表格视图、看板视图、画册视图、甘特视图和表单视图等,可参考飞书帮助中心文档视图类型。一个数据表至少有一个视图,可能有多个视图。每个视图都有唯一标识 view_idview_id 在一个多维表格中唯一,在全局不一定唯一。 你可通过多维表格 URL 获取 view_id,下图高亮部分即为当前视图的唯一标识。你也可通过列出视图接口获取 view_id。暂时无法获取到嵌入到文档中的多维表格的 view_id

表单视图 form

表单视图是多维表格的一种视图类型,形式类似于问卷,可以用来收集信息和数据。每个表单都有唯一标识 form_id,即当前视图的 view_idform_id 的获取方式和 view_id 的获取方式相同。

记录 record

数据表中的每一行数据都是一条记录(record)。每条记录都有唯一标识 record_idrecord_id 在一个多维表格中唯一,在全局不一定唯一。record_id 需要通过查询记录接口获取。

字段 field

即多维表格的“列”,多维表格提供丰富的字段类型。每个字段都有唯一标识 field_idfield_id 在一个多维表格内唯一,在全局不一定唯一。field_id 需要通过列出字段接口获取。了解更多字段说明,参考字段编辑指南

仪表盘 block

仪表盘与数据看板类似,可以从不同的维度统计对多维表格中的数据进行统计。了解更多,参考飞书帮助中心文档使用多维表格仪表盘

仪表盘的唯一标识为 block_id,以 blk 开头,你可通过多维表格 URL 获取 block_id,下图高亮部分即为当前仪表盘的唯一标识,也可通过列出仪表盘接口获取。

image.png

高级权限

高级权限允许用户针对单一数据表设置哪些用户可以查看、编辑指定的行,或是设置针对某用户可以编辑的列。高级权限接口分为 自定义角色协作者 两部分,多维表格的 所有者 或者 有可管理权限 的用户可通过接口设置高级权限,管理高级权限的协作者。了解更多,参考高级权限概述

自定义角色 role

在高级权限中添加角色并设置权限,该角色即为自定义角色。每个自定义角色都有唯一标识 role_idrole_id 需要通过列出自定义角色接口获取。

协作者 member

高级权限设置中,一个自定义角色(role)中的成员,即为协作者(member)。每个协作者都有唯一标识 member_idmember_id 需要通过列出协作者接口获取。

自动化流程 workflows

自动化流程是用户给多维表格设定的自动运行规则。设定“触发条件”和“执行操作”以后,多维表格会根据数据变更,自动执行下一步操作。你可通过列出自动化流程获取自动化流程的 ID,即 workflow_id

方法列表

以下为多维表格的方法列表。其中,“商店”代表商店应用;“自建”代表企业自建应用,了解更多应用相关信息,参考应用类型简介。了解调用服务端 API 的流程,参考流程概述

多维表格 app

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[创建多维表格](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create) POST/open-apis/bitable/v1/apps base:app:create 创建多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[复制多维表格](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy) POST/open-apis/bitable/v1/apps/:app_token/copy base:app:copy 复制多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[获取多维表格元数据](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get) GET/open-apis/bitable/v1/apps/:app_token bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新多维表格元数据](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update) PUT/open-apis/bitable/v1/apps/:app_token bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

数据表 table

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出数据表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list) GET/open-apis/bitable/v1/apps/:app_token/tables bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增数据表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create) POST /open-apis/bitable/v1/apps/:app_token/tablesbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增多个数据表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create) POST /open-apis/bitable/v1/apps/:app_token/tables/batch_createbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除数据表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete) DELETE /open-apis/bitable/v1/apps/:app_token/tables/:table_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除多个数据表](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete) POST /open-apis/bitable/v1/apps/:app_token/tables/batch_deletebitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

视图 view

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出视图](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list) GET/open-apis/bitable/v1/apps/:app_token/tables/:table_id/views bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增视图](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/viewsbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新视图](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch) PATCH/open-apis/bitable/v1/apps/:app_token/tables/:table_id/views/:view_id bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[检索视图](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get) GET/open-apis/bitable/v1/apps/:app_token/tables/:table_id/views/:view_id base:view:read 检索视图 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格tenant_access_token user_access_token
[删除视图](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete) DELETE /open-apis/bitable/v1/apps/:app_token/tables/:table_id/views/:view_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

记录 record

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list) GET/open-apis/bitable/v1/apps/:app_token/tables/:table_id/records bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[检索记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get) GET /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/:record_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/recordsbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增多条记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/batch_createbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update) PUT /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/:record_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新多条记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/batch_updatebitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete) DELETE /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/:record_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除多条记录](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/batch_deletebitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

字段 field

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出字段](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list) GET/open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields bitable:app:readonly 查看、评论和导出多维表格 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增字段](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create) POST /open-apis/bitable/v1/apps/:app_token/tables/:table_id/fieldsbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新字段](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update) PUT /open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields/:field_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除字段](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete) DELETE /open-apis/bitable/v1/apps/:app_token/tables/:table_id/fields/:field_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

仪表盘 dashboard

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[复制仪表盘](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy) POST/open-apis/bitable/v1/apps/:app_token/dashboards/:block_id/copy base:dashboard:copy 复制仪表盘 bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[列出仪表盘](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list) GET /open-apis/bitable/v1/apps/:app_token/dashboardsbase:dashboard:read 获取仪表盘信息 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格tenant_access_token user_access_token

自定义角色 role

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出自定义权限](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list) GET/open-apis/bitable/v1/apps/:app_token/roles bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增自定义权限](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create) POST /open-apis/bitable/v1/apps/:app_token/roles/:role_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[更新自定义权限](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update) PUT /open-apis/bitable/v1/apps/:app_token/roles/:role_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除自定义权限](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete) DELETE /open-apis/bitable/v1/apps/:app_token/roles/:role_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

协作者 member

高级权限下的协作者。

方法 (API)权限要求(满足任一)访问凭证(选择其一)商店自建
[列出协作者](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list) GET/open-apis/bitable/v1/apps/:app_token/roles/:role_id/members bitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[新增协作者](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create) POST /open-apis/bitable/v1/apps/:app_token/roles/:role_id/membersbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[删除协作者](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete) DELETE /open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/:member_idbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[批量新增协作者](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create) POST /open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/batch_createbitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token
[批量删除协作者](https://open.larkoffice.com/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete) DELETE /open-apis/bitable/v1/apps/:app_token/roles/:role_id/members/batch_deletebitable:app 查看、评论、编辑和管理多维表格tenant_access_token user_access_token

内容来源:飞书开放平台 · 自动爬取整理