飞书API 2-3：如何使用 API 创建数据表，解放人工？

一、引入

作为飞书多维表的深度使用者，经常需要将一些数据库的数据同步到多维表上，在数据写入之前，一般需要新建数据表和字段。当通过网页端界面新建字段时，如果字段少，还能接受手动一个个创建，不过一旦字段比较多，操作起来特别繁琐，机械地重复着，有点怀疑人生。

这种情况下，急需一个更加自动化的方式来解决！这不，飞书官方便提供了这样的 API 方便我们快速建数据表和字段。
注：数据表和多维表不是同个东西，多维表包含数据表，一个多维表中可以创建多个数据表，和 Excel 的逻辑差不多，多维表类比 Excel 文件，数据表类比 Sheet 表，区别参考如下：
image.png

本文就来探讨下如何通过飞书的 API 在多维表中创建数据表并插入数据，主要包含三方面：

  • 创建数据表
  • 对表的列进行增减等操作

二、创建数据表

2.1 多维表权限问题

注意：如果多维表不是通过应用创建，需要添加权限。

添加权限的方法也很简单，打开多维表，然后在右上角有三个横向的点，点击它，在调出的窗口中选择更多>添加文档应用。
image.png

在弹出的界面输入应用名称进行搜索，选中应用，配置编辑或管理权限，点击添加即可。
image.png

2.2 建数据表 API 调试

💡API 文档：新建一个数据表
获得权限之后，才能使用应用操作多维表。
创建数据表，至少需要三个配置项：数据表名称、视图名称、一个列。可查看示例值：

{
  "table": {
    "name": "数据表名称",
    "default_view_name": "默认的表格视图",
    "fields": [
      {
        "field_name": "多行文本",
        "type": 1
      }
    ]
  }
}

打开 API 调试台，需要输入 app_token 和 请求体。
如何获取 app_token？

  • 如果是通过 API 创建多维表，可以通过响应体提取到 app_token，响应体的结构如下。这种情况下，可以通过response.json().get('data').get('app').get('app_token')获取，或者参考 飞书 API 2-2 直接调用函数cre_bitable()获取。

image.png

  • 如果是针对已经创建好的多维表，查看地址栏获取

image.png

请求体可以使用默认的示例值，输入 app_token 和请求体之后，开始调试。
image.png

请求成功之后，会返回默认的视图 ID 和数据表的 ID，结果参考如下：
image.png

查看多维表，新建了一个名叫“数据表名称”的数据表，有一个默认视图叫默认的表示视图，该表有一列，叫多行文本。
image.png

三、字段操作

如果对现有的多维表的字段结构不满意，可以对数据表的字段进行新增、删除、更新操作。
对数据表进行字段操作都需要传递“app_token”和“table_id”。不同接口还有一些别的要求，新增字段需要传递请求体、更新字段需要传递“field_id”和请求体、删除字段需要传递“field_id”。
下文都通过上面创建的数据表来操作，所以 app_token 和 table_id 都是一样的，只讨论额外需要的参数。

3.1 新增字段

💡API 文档：新增字段
新增字段的请求体比较简单，一个字段名和字段类型即可，示例值如下：

{
    "field_name":"多行文本",
    "type":1
}

类型“1”表示1：多行文本，在前面 飞书API（5）中介绍 28 种数据类型的时候，介绍过该类型包含了三种子类型：多行文本、条码和 Email。默认是使用第一个，如果要使用后面的值类型，需要传递“ui_type”参数。

数据类型编码数据类型中文描述数据类型对应英文描述
1多行文本、条码Text,Barcode
1Email邮箱Email

比如，我要创建一个 条码，可使用以下请求体

{
    "field_name":"条码",
    "type":1,
    "ui_type":"Barcode"
}

成功之后，可以看到响应体会有相关字段的返回说明
image.png

一个 bug：虽然 Email 也是类型“1”，但是指定：“ui_type”:“Email” 之后，并不能成功创建 Email 类型的字段
image.png

在多维表上面显示和返回一致，是一个文本类型，而不是 Email。
image.png

3.2 更新字段

💡API 文档：更新字段
创建不了 Email，通过更新试试能不能处理。
相比新增字段，更新字段需要多传递一个参数：field_id，从新增的响应体可以了解到，邮箱字段的 field_id 是“fldhROhC0C”。请求体和新增字段时一致，发起调试请求后，报错了：DataNotChange（数据无变更）。说明更新字段也无法更改为“Email”类型。
image.png

那么如果要使用“Email”字段，就只能通过界面进行创建或修改，下面展示修改的的方法，创建直接点击添加字段选择“Email”即可。
image.png

换个需求：将第一个字段多行文本修改为自增数字的序号，多行文本字段的“field_id”为“fldvonP6L8”，请求体如下：

{
    "field_name":"序号",
    "type":1005,
    "ui_type":"AutoNumber"
}

调试结果如下，修改成功
image.png

查看多维表，已更新过来。
image.png

如果不知道“field_id”，怎么办？
调用列出字段的 API，填入“app_token”和“table_id”两个参数即可发起调试，查看对应数据表的字段信息。（💡API 文档：列出字段）
image.png

3.3 删除字段

💡API 文档：删除字段
把条码字段删除。把“field_id”参数填写之后发起调试，便可以把条码字段删除。
image.png

查看多维表，已删除条码字段。
image.png

3.4 字段说明

飞书的字段类型有两个级别，主字段类型（“type”）和 ui 类型（“ui_type”）。
前面说到飞书共有 28 种数据类型，这个是指字段的 ui 类型（“ui_type”），主字段类型（“type”）是23种类型，多行文本、条码、邮箱这三类 ui 类型统一为多行文本类型，数字、进度、货币、评分这四类 ui 类型统一为数字类型。
能通过接口创建的字段类型如下：

  • “type”类型支持：1,2,3,4,5,7,11,13,15,17,18,20,21,22,23,1001,1002,1003,1004,1005。
  • “ui_type”类型支持：Text,Barcode,Number,Progress,Currency,Rating,SingleSelect,MultiSelect,DateTime,Checkbox,User,GroupChat,Phone,Url,Attachment,SingleLink,Formula,DuplexLink,Location,CreatedTime,ModifiedTime,CreatedUser,ModifiedUser,AutoNumber。

换个说法，不支持以下 4 种字段类型通过 API 创建：邮箱、查找引用、流程、按钮。
虽然其他的支持接口创建，但是有一些需要加上字段属性（“property”）：进度、货币、评分、单向关联、双向关联。

  • 进度：需要在“property”中指定格式
  • 货币：需要在“property”中指定格式和货币类型
  • 评分：需要在“property”中指定格式和大小值
  • 单向关联：需要在“property”中指定引用的目标表和选择类型（单选/双选）
  • 双向关联：需要在“property”中指定引用的目标表和选择类型（单选/双选）和目标表的字段名

注意：公式如果没有传递“property”参数指定计算公式，是一个空公式。更多信息科参考：字段编辑指南。

在创建数据表时，可以传递以下请求体，创建一个包含所有支持通过 API 创建的字段的数据表。
特别注意单向关联和双向关联中的“property”的“table_id”的值需要修改为你的多维表下的其他数据表的“table_id”，如果没有，需要去掉该字段，否则将创建失败。

{
  "table": {
    "name": "所有支持类型字段的数据表",
    "default_view_name": "一个视图",
    "fields": [
      {"field_name": "自动编号","type": 1005,"ui_type": "AutoNumber"},
      {"field_name": "多行文本","type": 1,"ui_type": "Text"},
      {"field_name": "条码","type": 1,"ui_type": "Barcode"},
      {"field_name": "数字","type": 2,"ui_type": "Number"},
      {"field_name": "进度","type": 2,"ui_type": "Progress",
          "property": {"formatter": "0.00%","min": 0.1,"max": 4,"range_customize": true}
          },
      {"field_name": "货币","type": 2,"ui_type": "Currency",
          "property": {"formatter": "0.0", "currency_code": "CNY" }
          },
      {"field_name": "评分","type": 2,"ui_type": "Rating",
          "property": {"formatter": "0", "min": 0, "max": 5, "rating": {"symbol": "star" }}
          },
      {"field_name": "单选","type": 3,"ui_type": "SingleSelect"},
      {"field_name": "多选","type": 4,"ui_type": "MultiSelect"},
      {"field_name": "日期","type": 5,"ui_type": "DateTime"},
      {"field_name": "复选框","type": 7,"ui_type": "Checkbox"},
      {"field_name": "人员","type": 11,"ui_type": "User"},
      {"field_name": "电话号码","type": 13,"ui_type": "Phone"},
      {"field_name": "超链接","type": 15,"ui_type": "Url"},
      {"field_name": "附件","type": 17,"ui_type": "Attachment"},
      {"field_name": "单向关联","type": 18,"ui_type": "SingleLink",
          "property": {"multiple": true,"table_id": "tblwZPx4ezszTIEh" }  
          },
      {"field_name": "公式","type": 20,"ui_type": "Formula"},
      {"field_name": "双向关联","type": 21,"ui_type": "DuplexLink",
          "property": {"multiple": false,"table_id": "tblwZPx4ezszTIEh","back_field_name": "双向关联-自动生成" }
          },
      {"field_name": "地理位置","type": 22,"ui_type": "Location"},
      {"field_name": "群组","type": 23,"ui_type": "GroupChat"},
      {"field_name": "创建时间","type": 1001,"ui_type": "CreatedTime"},
      {"field_name": "最后更新时间","type": 1002,"ui_type": "ModifiedTime"},
      {"field_name": "创建人","type": 1003,"ui_type": "CreatedUser"},
      {"field_name": "修改人","type": 1004,"ui_type": "ModifiedUser"}
    ]
  }
}

四、小结

本文探讨了如何通过 API 接口创建飞书多维表的数据表，在字段比较多的时候，方便快速创建表，而不需要在 UI 界面机械操作。基本步骤如下：

  • 授权：给应用开通多维表的写权限；
  • API 建表：梳理字段并调用 API 接口建表。

同时，探讨了字段的新增、更新和删除，以及介绍了多维表所有字段类型的特性。

  • 字段新增：需要“app_token”、“table_id”、字段名及数据类型；
  • 字段更新：需要“app_token”、“table_id”、“field_id”、新字段名及数据类型；
  • 字段删除：需要“app_token”、“table_id”和“field_id”。

最后，28 种字段类型的梳理如下：

序号typeui_type中文描述API 支持说明
11Text多行文本支持
21Barcode条码支持
31Email邮箱不支持
42Number数字支持
52Progress进度支持需要 property
62Currency货币支持需要 property
72Rating评分支持需要 property
83SingleSelect单选支持
94MultiSelect多选支持
105DateTime日期支持
117Checkbox复选框支持
1211User人员支持
1313Phone电话号码支持
1415Url超链接支持
1517Attachment附件支持
1618SingleLink单向关联支持需要 property
1719Lookup查找引用不支持
1820Formula公式支持空公式
1921DuplexLink双向关联支持需要 property
2022Location地理位置支持
2123GroupChat群组支持
2224Stage流程不支持
231001CreatedTime创建时间支持
241002ModifiedTime最后更新时间支持
251003CreatedUser创建人支持
261004ModifiedUser修改人支持
271005AutoNumber自动编号支持
283001Button按钮不支持



附录：代码小结


import requests
import json

def cre_data_sheet(access_token,app_token,request_body):
    url = f"https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables"
    payload = json.dumps(request_body)
    
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {access_token}'
    }

    payload = json.dumps(request_body)
    
    response = requests.request("POST", url, headers=headers, data=payload)
    code = response.json()['code']
    if code == 0:
        table_id = response.json().get("data").get("table_id")
        tb_name = request_body["table"]["name"]
        print(f"成功新建数据表：{tb_name}，数据表的 table_id 为：{table_id}。关联函数：cre_data_sheet。")
        return table_id
    else:
        msg = response.json().get("msg")
        raise f"新建数据表失败，失败信息：{msg}。关联函数：cre_data_sheet。"

def add_field(access_token,app_token,table_id,request_body):
    url = f"https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/fields"
    payload = json.dumps(request_body)
    
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {access_token}'
    }
    
    response = requests.request("POST", url, headers=headers, data=payload)
    code = response.json()['code']
    if code == 0:
        field_id = response.json().get("data").get("field").get("field_id")
        field_name = request_body["field_name"]
        print(f"成功新增字段：{field_name}，该字段的 field_id 为：{field_id}。关联函数：add_field。")
        return table_id
    else:
        msg = response.json().get("msg")
        raise f"新增字段失败，失败信息：{msg}。关联函数：add_field。"

def update_field(access_token,app_token,table_id,field_id,request_body):
    url = f"https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/fields/{field_id}"
    payload = json.dumps(request_body)
    
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {access_token}'
    }
    
    response = requests.request("PUT", url, headers=headers, data=payload)
    code = response.json()['code']
    if code == 0:
        field_id = response.json().get("data").get("field").get("field_id")
        field_name = request_body["field_name"]
        print(f"成功更新字段：{field_name}。关联函数：update_field。")
        return table_id
    else:
        msg = response.json().get("msg")
        raise f"更新字段失败，失败信息：{msg}。关联函数：update_field。"

def del_field(access_token,app_token,table_id,field_id):    
    url = f"https://open.feishu.cn/open-apis/bitable/v1/apps/{app_token}/tables/{table_id}/fields/{field_id}"
    
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {access_token}'
    }
    
    response = requests.request("DELETE", url, headers=headers)
    code = response.json()['code']
    if code == 0:
        field_id = response.json().get("data").get("field_id")
        field_name = request_body["field_name"]
        print(f"成功删除字段：{field_name}。关联函数：del_field。")
        return table_id
    else:
        msg = response.json().get("msg")
        raise f"删除字段失败，失败信息：{msg}。关联函数：del_field。"

def get_tenant_access_token(app_id, app_secret):
    url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
    payload = json.dumps({
        "app_id": app_id,
        "app_secret": app_secret
    })
    headers = {'Content-Type': 'application/json'}
    response = requests.request("POST", url, headers=headers, data=payload)
    tenant_access_token = response.json()['tenant_access_token']
    print(f'成功获取tenant_access_token：{tenant_access_token}。关联函数：get_table_params。')
    return tenant_access_token

def main(request_body):
    app_id = 'your_app_id'
    app_secret = 'your_app_secret'
    app_token = 'your_app_token'
    request_body = {
      "table": {
        "name": "数据表名称",
        "default_view_name": "默认的表格视图",
        "fields": [
          {
            "field_name": "多行文本",
            "type": 1
          }
        ]
      }
    }
    access_token = get_tenant_access_token(app_id, app_secret)
    table_id = cre_data_sheet(access_token,app_token,request_body)

    # # 新增字段
    # request_body = {
    # 	"field_name": "条码",
    # 	"type": 1,
    # 	"ui_type": "Barcode"
    # }
    # add_field(access_token,app_token,table_id,request_body)

    # # 更新字段
    # request_body = {
    #     "field_name":"序号",
    #     "type":1005,
    #     "ui_type":"AutoNumber"
    # }
    # field_id = "your_field_id"
    # update_field(access_token,app_token,table_id,field_id,request_body)

    # # 删除字段
    # field_id = "your_field_id"
    # del_field(access_token,app_token,table_id,field_id)
    
if __name__ == '__main__':    
    main()

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/765766.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

C++字体库开发

C++字体库开发

建议根据字体需求，多个组合使用。高度定制可基于freeTypeharfbuzz基础库完成。 GitHub - GNOME/pango: Read-only mirror of https://gitlab.gnome.org/GNOME/pango GitHub - googlefonts/fontview: Demo app that displays fonts with a free/libre/open-source …
阅读更多...
更好的方法_交叉观察器API

更好的方法_交叉观察器API

交叉观察器（Intersection Observer）API 是一个强大的工具，可以用来检测元素是否进入视口或从视口移出。我们可以利用这个 API 来实现粘贴式导航（也称为粘性导航），即在用户滚动页面时，导航栏会在…
阅读更多...
方法的用法

方法的用法

一.简介 目前为止我给出的所有的案例都是将代码放在main方法中，就会产生一些问题： 代码冗长，不利于维护变量过多，想不出那么多的变量名没有重用性 那么该如何解决呢？ 我们可以编写功能性的代码块，来被ma…
阅读更多...
Android自动化测试实践：uiautomator2 核心功能与应用指南

Android自动化测试实践：uiautomator2 核心功能与应用指南

Android自动化测试实践：uiautomator2 核心功能与应用指南 uiautomator2 是一个用于Android应用的自动化测试Python库，支持多设备并行测试操作。它提供了丰富的API来模拟用户对App的各种操作，如安装、卸载、启动、停止以及清除应用数据等。此外…
阅读更多...
基于索尼基于索尼Spresense的眼睛跟随平台中两个模型的对比

基于索尼基于索尼Spresense的眼睛跟随平台中两个模型的对比

1.模型一(现在使用的) 这个模型是一个简单的神经网络，由三个主要组件组成：输入层、一个全连接层（Affine层）、一个Sigmoid激活函数层和一个Binary Cross Entropy损失层。 以下是每个组件的说明： Input 层：这…
阅读更多...
计算机专业的概念需要拓宽｜终身学习之旅利：用FlowUs打造个性化学习记录知识库

计算机专业的概念需要拓宽｜终身学习之旅利：用FlowUs打造个性化学习记录知识库

计算机相关专业长期以来一直是热门选择，这主要得益于技术的快速发展和广泛的应用场景。随着AI技术的不断进步，这一趋势在未来几年内仍有望持续。以下是从不同角度对这个问题的分析： 从AI发展的角度： 技术革新：AI技术…
阅读更多...
axios的底层ajax，XMLHttpRequest原理解释及使用方法

axios的底层ajax，XMLHttpRequest原理解释及使用方法

定义 ajax全称asychronous JavaScript and XML 意思是异步的 JavaScript和xml， 也就是通过javascript创建XMLHttpRequest （xhr）对象与服务器进行通信 步骤 创建实例对象，初始请求方法和url，设置监听器监听请求完成…
阅读更多...
人工智能在音乐创作中的双刃剑：创新与挑战

人工智能在音乐创作中的双刃剑：创新与挑战

AI在创造还是毁掉音乐？ 简介 最近一个月，轮番上线的音乐大模型，一举将素人生产音乐的门槛降到了最低，并掀起了音乐圈会不会被AI彻底颠覆的讨论。短暂的兴奋后，AI产品的版权归属于谁，创意产业要如何在AI的阴…
阅读更多...
经典FC游戏web模拟器--EmulatorJS

经典FC游戏web模拟器--EmulatorJS

简介 EmulatorJS是一个基于JavaScript和Webassembly技术的虚拟环境的实现，可以在网页中运行各种经典FC游戏系统，支持任天堂、世嘉、雅达利等经典红白机。EmulatorJS的诞生使得诸如超级玛丽、坦克大战、魂斗罗等经典FC游戏能够以一种全新的方式回归。本文…
阅读更多...
开源模型应用落地-FastAPI-助力模型交互-WebSocket篇（六）

开源模型应用落地-FastAPI-助力模型交互-WebSocket篇（六）

一、前言 使用 FastAPI 可以帮助我们更简单高效地部署 AI 交互业务。FastAPI 提供了快速构建 API 的能力,开发者可以轻松地定义模型需要的输入和输出格式,并编写好相应的业务逻辑。 FastAPI 的异步高性能架构,可以有效支持大量并发的预测请求,为用户提供流畅的交互体验。此外,F…
阅读更多...
动手学深度学习 --带你了解chatgpt，跟上AI发展！

动手学深度学习 --带你了解chatgpt，跟上AI发展！

本书旨在向读者交付有关深度学习的交互式学习体验。书中不仅阐述深度学习的算法原理，还演示它们的实现和运行。与传统图书不同，本书的每一节都是一个可以下载并运行的 Jupyter记事本，它将文字、公式、图像、代码和运行结果结合在了一起。此外…
阅读更多...
【JS】纯web端使用ffmpeg实现的视频编辑器-视频合并

【JS】纯web端使用ffmpeg实现的视频编辑器-视频合并

纯前端实现的视频合并 接上篇ffmpeg文章 【JS】纯web端使用ffmpeg实现的视频编辑器 这次主要添加了一个函数，实现了视频合并的操作。 static mergeArgs(timelineList) {const cmd []console.log(时间轴数据,timelineList)console.log("文件1",this.readD…
阅读更多...
openGauss真的比PostgreSQL差了10年？

openGauss真的比PostgreSQL差了10年？

前不久写了MogDB针对PostgreSQL的兼容性文章，我在文中提到针对PostgreSQL而言，MogDB兼容性还是不错的，其中也给出了其中一个能源客户之前POC的迁移报告数据。 But很快我发现总有人回留言喷我，而且我发现每次喷的这帮人是根本不看文…
阅读更多...
容器内存

容器内存

一、容器内存概述 容器本质上还是一个进程，是一个被隔离和限制的进程。因此容器内存和进程内存在表现形式上其实是一样的，这块主要涉及三部分内容：RSS，page cache和swap这三部分，容器基于memory Cgroup对内存进行限制…
阅读更多...
Xorbits inference操作实战

Xorbits inference操作实战

1.操作环境 序号软件版本备注1Windows1.版本：Windows 10 专业版2.版本号：21H23.操作系统内部版本：19044.18892Docker Desktop4.24.2 (124339)3WSLUbuntu 22.04 LTS4Python3.105CUDA12.16Dify0.6.6 Xorbits inference 是一个强大且通用的分布…
阅读更多...
Python基础001

Python基础001

Python输出语句 print输出字符串 print("中国四大名著：","西游记|","三国演义|","红楼梦|","水浒传") print(6) print(1 1)Python输入语句 input函数 input() input("我的名字是：") p…
阅读更多...
在非 antd pro 项目中使用 umi OpenAPI

在非 antd pro 项目中使用 umi OpenAPI

大家好，我是松柏。自从跟着鱼皮哥使用了ant design pro中的OpenAPI插件之后，我已经无法忍受自己写请求后端接口的方法了，所以这篇文章记录一下如何在非ant design pro项目中使用OpenAPI。 安装依赖 首先我们需要安装包umijs/openapi&#x…
阅读更多...
java面试课程-SpringIOC部分源码解析

java面试课程-SpringIOC部分源码解析

1.SpringIOC的refresh源码解析 核心： 核心使用的是： 需要完成配置类的解析，各种BeanFactoryProcessor的注册。还有写国际化配置的初始化。Web容器的内部构造。 上面几个方法是refresh方法的内容。注意可以与applicationContext里的内容一起…
阅读更多...
Profibus DP主站转Modbus网关连接智能化电表通讯

Profibus DP主站转Modbus网关连接智能化电表通讯

Profibus DP主站转Modbus网关（XD-MDPBM20），是实现不同工业通信协议之间互联互通的设备，主要将Profibus DP协议转换为Modbus协议，实现数据的双向传输。通过Profibus DP主站转Modbus网关（XD-MDPBM20&#xff…
阅读更多...
大Excel表格76M，电脑16G内存打不开，内存利用率100%虚拟内存占用16G还是卡死提示内存不足，如何才能查看里面内容？

大Excel表格76M，电脑16G内存打不开，内存利用率100%虚拟内存占用16G还是卡死提示内存不足，如何才能查看里面内容？

环境： Excel2016 问题描述： 大Excel表格76M，电脑16G内存打不开，内存利用率100%虚拟内存占用16G还是卡死提示内存不足，如何才能查看里面内容？ 解决方案： 遇到这种情况，说明Excel文件非常大，超出了你当前计算机配置的处理能力。以下是一些解决方法，帮助你尝试打开或…
阅读更多...
最新文章

Copyright @ 2022~2023