飞书多维表格
飞书多维表格 是一个办公协同插件,以插件能力的形式出现在指令树「扩展能力」中。安装或内置加载后,可把插件里的节点拖到工作流画布使用。
插件标识:rpa-plugin-feishu-bitable
插件分类:办公协同插件
节点数量:28 个
先选使用方式
Section titled “先选使用方式”| 方式 | 怎么用 | 适合人群 |
|---|---|---|
| 可视化编排(推荐) | 在「扩展能力」中找到 飞书多维表格,拖入需要的节点并填写参数 | 大多数用户,适合按表单配置插件能力 |
| 代码编排(执行指令 XML) | 通过「执行指令(XML)」调用节点的 type 与参数 | 需要动态拼装、循环调用或批量处理的用户 |
什么时候用?
Section titled “什么时候用?”- 覆盖飞书多维表格 (Bitable) 全套原子节点:连通性 / 列表 / 表 meta / 单条 CRUD / 搜索 / 批量 / 知识库 / 附件 / Schema 管理(Table、View、Field)。需先在「连接管理」配置 feishu-app(飞书自建应用 App ID + App Secret),节点通过 connectionId 引用即可,无需手动管理 tenant_access_token。
- 需要在自动化流程中复用该插件提供的读取、写入、同步或处理能力。
- 需要先配置连接:feishu-app。
- 办公协同类能力需要确认文件、表格、空间或数据库的访问权限。
- 建议先运行连通性、查询或只读节点,确认权限和参数正确后再执行写入类节点。
| 连接类型 | 名称 | 说明 |
|---|---|---|
feishu-app | feishu-app | 通过 App ID + App Secret 调用多维表格、知识库、云空间 OpenAPI |
| 节点名称 | 节点标识 | 说明 |
|---|---|---|
| 连通性测试 | BitablePing | 向飞书 OpenAPI 换一次 tenant_access_token 验证 App 凭据可用 |
| 列出数据表 | ListBitableTables | 列出指定多维表格 (base) 内的所有数据表。常用作其它节点前的准备步骤,先拿到 tableId 再操作记录 |
| 获取数据表字段元信息 | GetBitableTableMeta | 获取指定 table 的字段定义,含字段类型、属性等 |
| 搜索多维表格记录 | SearchBitableRecords | 按 filter / sort / fieldNames / pageSize 翻页搜索表内记录,自动 codec 字段值 |
| 获取单条记录 | GetBitableRecord | 按 record_id 取单条记录,自动 codec 字段值 |
| 新建记录 | CreateBitableRecord | 向数据表插入一条新记录,fields 接受扁平 JSON,自动 codec 转换 |
| 更新记录 | UpdateBitableRecord | 按 record_id 更新单条记录的字段值(只需传需要修改的字段) |
| 删除记录 | DeleteBitableRecord | 按 recordId 删除单条记录。删除后不可恢复(除非在多维表格回收站找回) |
| 批量新建记录 | BatchCreateBitableRecords | 一次最多 1000 条;超过自动分片。records 接受 JSON 数组(每项是扁平 fields 对象),自动 codec。中途失败时已写入批次无法回滚(hint 会提示已写入条数与 recordIds,便于去重重跑) |
| 批量删除记录 | BatchDeleteBitableRecords | 按 recordId 数组批量删除。一次最多 500 条,超过自动分片。删除不可恢复;中途失败时已删除批次无法回滚(hint 会提示已删除条数) |
| 批量获取记录 | BatchGetBitableRecords | 一次最多 100 条按 record_id 取记录;支持 with_shared_url、automatic_fields |
| 解析知识库 wiki token | ResolveBitableWikiToken | 把飞书知识库 /wiki/<token> 链接或 wikiToken 显式解析成 base obj_token;多数情况下其它节点 会自动调用本接口,无需手动使用 |
| 上传附件 | UploadBitableAttachment | 把本地文件上传到飞书云空间,拿 fileToken 用于多维表格附件字段。≤20MB 单传,>20MB 自动分片 |
| 下载附件 | DownloadBitableAttachment | 通过 fileToken 把飞书附件下载到本地;savePath 可传目录或完整路径 |
| 新建数据表 | AddBitableTable | 在 base 内新建一个数据表,可选 defaultViewName / 初始 fields |
| 删除数据表 | DeleteBitableTable | 删除一个数据表(含全部记录、视图、字段,不可恢复) |
| 重命名数据表 | UpdateBitableTable | 修改一个数据表的名称 |
| 列出视图 | ListBitableViews | 列出指定 table 下的所有视图 |
| 新建视图 | AddBitableView | 新建一个视图,viewType 支持 grid / kanban / gallery / gantt / form / hierarchy / calendar |
| 删除视图 | DeleteBitableView | 删除一个视图。删除不可恢复 |
| 更新视图 | UpdateBitableView | 重命名视图或修改视图属性(property) |
| 新建字段 | AddBitableField | 新建一个字段。fieldType / uiType 二选一;property 可传 JSON 配置选项 |
| 更新字段 | UpdateBitableField | 修改字段(重命名 / 改类型 / 改属性 / 改描述) |
| 删除字段 | DeleteBitableField | 删除一个字段(含所有记录中该字段的值,不可恢复) |
| 批量更新记录 | BatchUpdateBitableRecords | 批量更新多条记录。records 每项必须带 recordId;单批最多 1000 条,超出自动切片 |
| 获取多维表应用元信息 | GetBitableAppMeta | 获取 bitable app 层别的元信息(名称 / revision / 时区 / 是否启用高级权限),不需 tableId |
| 修改多维表应用名称/高级权限 | UpdateBitableAppMeta | 重命名 bitable app,或切换高级权限(需 owner 权限)。name 与 isAdvanced 至少传一个 |
| 新建多维表应用 | CreateBitableApp | 在指定云盘文件夹下创建一个全新的多维表 app(含一个默认表) |
节点参数与输出
Section titled “节点参数与输出”- 节点标识:
BitablePing - 节点说明: 向飞书 OpenAPI 换一次 tenant_access_token 验证 App 凭据可用
- XML 示例:
<BitablePing connectionId="" outKey="pingResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 输出变量名 | outKey | output | 否 | pingResult | ping 结果将写入此变量 |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
pingResult | object | 成功:{ ok:true, data:{ connected:true }, statusCode, attempts, durationMs, logId? };失败:{ ok:false, error, code, category, hint? } |
- 节点标识:
ListBitableTables - 节点说明: 列出指定多维表格 (base) 内的所有数据表。常用作其它节点前的准备步骤,先拿到 tableId 再操作记录
- XML 示例:
<ListBitableTables connectionId="" url="" pageSize="100" outKey="tables" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | 粘贴 base / wiki 链接,自动解析;与 appToken 二选一 |
| appToken(替代 url) | appToken | string | 否 | - | 直接传 base 的 obj_token;不填则从 url 解析 |
| 每页条数 | pageSize | number | 否 | 100 | 默认 100,最大 100 |
| 最多翻页数 | maxPages | number | 否 | 50 | 防御无限循环;默认 50,上限 500 |
| 输出变量名 | outKey | output | 否 | tables | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
tables | object | { ok:true, data:{ tables:[{tableId, name, revision?}], total }, statusCode, attempts, durationMs, logId? } |
获取数据表字段元信息
Section titled “获取数据表字段元信息”- 节点标识:
GetBitableTableMeta - 节点说明: 获取指定 table 的字段定义,含字段类型、属性等
- XML 示例:
<GetBitableTableMeta connectionId="" url="" tableId="" outKey="tableMeta" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | 完整 URL(含 ?table=);与 appToken+tableId 二选一 |
| appToken(替代 url) | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | 数据表 ID;URL 已包含时可不填 |
| 包含字段选项 | includeOptions | boolean | 否 | true | true 时附带 ui_type / property(含选项列表等),便于上层 codec |
| 每页条数 | pageSize | number | 否 | 100 | 默认 100,最大 100 |
| 最多翻页数 | maxPages | number | 否 | 20 | 字段元信息一般 1-2 页,默认 20,上限 200 |
| 输出变量名 | outKey | output | 否 | tableMeta | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
tableMeta | object | { ok:true, data:{ appToken, tableId, fields:[{fieldId, fieldName, type, uiType?, isPrimary?, property?}], fieldsByName:{字段名:fieldId} }, statusCode, attempts, durationMs };fieldsByName 便于按列名取 fieldId |
搜索多维表格记录
Section titled “搜索多维表格记录”- 节点标识:
SearchBitableRecords - 节点说明: 按 filter / sort / fieldNames / pageSize 翻页搜索表内记录,自动 codec 字段值
- XML 示例:
<SearchBitableRecords connectionId="" url="" tableId="" pageSize="100" outKey="records" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | URL 或 appToken+tableId 任选其一 |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| viewId(可选) | viewId | string | 否 | - | 限定视图;URL 中 ?view= 也可 |
| 过滤条件(JSON) | filter | textarea | 否 | - | 飞书 filter DSL,例如 {“conjunction”:“and”,“conditions”:[{“field_name”:“状态”,“operator”:“is”,“value”:[“待处理”]}]} |
| 排序条件(JSON) | sort | textarea | 否 | - | JSON 数组,例如 [{“field_name”:“创建时间”,“desc”:true}] |
| 返回字段名(逗号或 JSON 数组) | fieldNames | string | 否 | - | 只返回这些字段,省 token;不填返回全部 |
| 每页条数 | pageSize | number | 否 | 100 | 默认 100,最大 500 |
| 自动翻页拉全部 | autoPaginate | boolean | 否 | true | true 时自动翻页直到取完所有匹配记录;false 时只取第一页 |
| 最多翻页数 | maxPages | number | 否 | 50 | 防御无限循环;默认 50,上限 1000 |
| 记录数上限 | maxRecords | number | 否 | - | 命中即停止;0 = 不限制;上限 1,000,000 |
| 自动解码字段值 | decodeValues | boolean | 否 | true | 把附件 / 人员 / 链接等复杂字段从飞书原始结构转成扁平 JSON |
| 返回系统字段 | automaticFields | boolean | 否 | - | true 时返回 record_id / created_time / created_by 等系统字段 |
| 输出变量名 | outKey | output | 否 | records | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
records | object | { ok:true, data:{ records:[{recordId, fields, …}], total, hasMore, pageToken? } } |
获取单条记录
Section titled “获取单条记录”- 节点标识:
GetBitableRecord - 节点说明: 按 record_id 取单条记录,自动 codec 字段值
- XML 示例:
<GetBitableRecord connectionId="" url="" tableId="" recordId="" outKey="record" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| recordId | recordId | string | 是 | - | recxxxxxxxx |
| 返回字段名(可选) | fieldNames | string | 否 | - | 逗号或 JSON 数组。说明:飞书 GET 单条接口本身不支持 field_names,这里仅在客户端裁剪输出 fields,不会减少飞书侧返回数据量 |
| 用户 ID 类型 | userIdType | select | 否 | open_id | 与写入侧保持一致避免人员字段 ID 类型不匹配 |
| 返回系统字段 | automaticFields | boolean | 否 | - | true 时返回 created_time / created_by / last_modified_time 等系统字段 |
| 自动解码字段值 | decodeValues | boolean | 否 | true | |
| 输出变量名 | outKey | output | 否 | record | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
record | object | { ok:true, data:{ recordId, fields, createdTime?, lastModifiedTime?, … } } |
- 节点标识:
CreateBitableRecord - 节点说明: 向数据表插入一条新记录,fields 接受扁平 JSON,自动 codec 转换
- XML 示例:
<CreateBitableRecord connectionId="" url="" tableId="" fields="{}" outKey="record" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| 字段值(JSON 对象) | fields | textarea | 是 | {} | 扁平 JSON:{ “标题”: “x”, “日期”: “2024-01-15”, “附件”: [“file_token_xxx”] };自动 codec |
| 用户 ID 类型 | userIdType | select | 否 | open_id | |
| 跳过 codec | skipCodec | boolean | 否 | - | true 时直接透传 fields 给飞书 API(你已自行准备好飞书原始结构时使用) |
| 严格 codec | strictCodec | boolean | 否 | - | true 时遇到字段元信息缺失或 codec 错误直接抛错;false 时降级为 warn |
| 输出变量名 | outKey | output | 否 | record | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
record | object | { ok:true, data:{ recordId, fields } } |
- 节点标识:
UpdateBitableRecord - 节点说明: 按 record_id 更新单条记录的字段值(只需传需要修改的字段)
- XML 示例:
<UpdateBitableRecord connectionId="" url="" tableId="" recordId="" fields="{}" outKey="record" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| recordId | recordId | string | 是 | - | recxxxxxxxx |
| 要更新的字段(JSON 对象) | fields | textarea | 是 | {} | 只传要改的字段;显式传 null 等于清空该字段 |
| 用户 ID 类型 | userIdType | select | 否 | open_id | |
| 跳过 codec | skipCodec | boolean | 否 | - | |
| 严格 codec | strictCodec | boolean | 否 | - | |
| 输出变量名 | outKey | output | 否 | record | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
record | object | { ok:true, data:{ recordId, fields } } |
- 节点标识:
DeleteBitableRecord - 节点说明: 按 recordId 删除单条记录。删除后不可恢复(除非在多维表格回收站找回)
- XML 示例:
<DeleteBitableRecord connectionId="" url="" tableId="" recordId="" outKey="deleteResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| recordId | recordId | string | 是 | - | recxxxxxxxx |
| 输出变量名 | outKey | output | 否 | deleteResult | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
deleteResult | object | { ok:true, data:{ recordId, deleted:true } } |
批量新建记录
Section titled “批量新建记录”- 节点标识:
BatchCreateBitableRecords - 节点说明: 一次最多 1000 条;超过自动分片。records 接受 JSON 数组(每项是扁平 fields 对象),自动 codec。中途失败时已写入批次无法回滚(hint 会提示已写入条数与 recordIds,便于去重重跑)
- XML 示例:
<BatchCreateBitableRecords connectionId="" url="" tableId="" records="[]" batchSize="500" outKey="records" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| 记录数组(JSON) | records | textarea | 是 | [] | 每项是一份扁平 fields 对象,例如 [{“标题”:“a”},{“标题”:“b”,“日期”:“2024-01-15”}] |
| 分片大小 | batchSize | number | 否 | 500 | 1-1000;默认 500 |
| 用户 ID 类型 | userIdType | select | 否 | open_id | |
| 跳过 codec | skipCodec | boolean | 否 | - | |
| 严格 codec | strictCodec | boolean | 否 | - | |
| 输出变量名 | outKey | output | 否 | records | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
records | object | { ok:true, data:{ records:[{recordId, fields}], total } } |
批量删除记录
Section titled “批量删除记录”- 节点标识:
BatchDeleteBitableRecords - 节点说明: 按 recordId 数组批量删除。一次最多 500 条,超过自动分片。删除不可恢复;中途失败时已删除批次无法回滚(hint 会提示已删除条数)
- XML 示例:
<BatchDeleteBitableRecords connectionId="" url="" tableId="" recordIds="[]" outKey="deleteResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| recordId 列表(JSON 或逗号分隔) | recordIds | textarea | 是 | [] | 支持 [“recA”,“recB”] 或 “recA,recB” |
| 分片大小 | batchSize | number | 否 | 500 | 1-500;默认 500 |
| 输出变量名 | outKey | output | 否 | deleteResult | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
deleteResult | object | { ok:true, data:{ records:[{recordId, deleted}], total } } |
批量获取记录
Section titled “批量获取记录”- 节点标识:
BatchGetBitableRecords - 节点说明: 一次最多 100 条按 record_id 取记录;支持 with_shared_url、automatic_fields
- XML 示例:
<BatchGetBitableRecords connectionId="" url="" tableId="" recordIds="[]" outKey="records" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 否 | - | tblxxxxxxxx |
| recordId 列表(JSON 或逗号分隔) | recordIds | textarea | 是 | [] | [] |
| 返回系统字段 | automaticFields | boolean | 否 | - | true 时返回 created_time / last_modified_time 等系统字段 |
| 返回 shared_url | withSharedUrl | boolean | 否 | - | true 时附带飞书表行的 shared_url |
| 自动解码字段值 | decodeValues | boolean | 否 | true | |
| 分片大小 | batchSize | number | 否 | 100 | 1-100;默认 100(飞书 API 上限) |
| 用户 ID 类型 | userIdType | select | 否 | open_id | |
| 输出变量名 | outKey | output | 否 | records | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
records | object | { ok:true, data:{ records, total, forbiddenRecordIds?, absentRecordIds? } } |
解析知识库 wiki token
Section titled “解析知识库 wiki token”- 节点标识:
ResolveBitableWikiToken - 节点说明: 把飞书知识库 /wiki/<token> 链接或 wikiToken 显式解析成 base obj_token;多数情况下其它节点 会自动调用本接口,无需手动使用
- XML 示例:
<ResolveBitableWikiToken connectionId="" url="" wikiToken="" outKey="wikiResolved" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 知识库链接 | url | string | 否 | - | 形如 https://xx.feishu.cn/wiki/<wiki_token>;与 wikiToken 二选一 |
| wikiToken(替代 url) | wikiToken | string | 否 | - | wikxxxxxxxx |
| 输出变量名 | outKey | output | 否 | wikiResolved | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
wikiResolved | object | { ok:true, data:{ wikiToken, objToken, tableId?, viewId?, objType:‘bitable’ } } |
- 节点标识:
UploadBitableAttachment - 节点说明: 把本地文件上传到飞书云空间,拿 fileToken 用于多维表格附件字段。≤20MB 单传,>20MB 自动分片
- XML 示例:
<UploadBitableAttachment connectionId="" url="" filePath="" outKey="attachment" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | 用于推断 parent_node = base 的 obj_token;与 appToken / parentNode 三者任一即可 |
| appToken(替代 url) | appToken | string | 否 | - | |
| parentNode(高级,覆盖默认) | parentNode | string | 否 | - | 完整传飞书云空间挂载节点;不填则自动用 url/appToken 解析的 base obj_token |
| 本地文件路径 | filePath | string | 是 | - | 需为绝对路径或工作目录可达的文件路径 |
| 附件类型 | parentType | select | 否 | - | 不填则按文件扩展名自动识别(图片→bitable_image,其它→bitable_file)。强制指定时按此值 |
| 分片大小(字节) | chunkSize | number | 否 | 4194304 | 默认 4MB;仅 >20MB 文件触发分片上传 |
| 输出变量名 | outKey | output | 否 | attachment | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
attachment | object | { ok:true, data:{ fileToken, fileName, size, parentType }, statusCode, attempts, durationMs };用 data.fileToken 拼到附件字段值即可,例如 fields={“附件”:[{“file_token”:”…”}]} |
- 节点标识:
DownloadBitableAttachment - 节点说明: 通过 fileToken 把飞书附件下载到本地;savePath 可传目录或完整路径
- XML 示例:
<DownloadBitableAttachment connectionId="" fileToken="" savePath="" outKey="attachment" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| fileToken | fileToken | string | 是 | - | 可来自附件字段、或本插件 UploadBitableAttachment 的输出 |
| 本地保存路径 | savePath | string | 是 | - | 建议传绝对路径(如 ~/Downloads/ 或 D:\downloads\)。传目录时使用 Content-Disposition 解析的文件名;传完整路径则直接用 |
| extra(高级) | extra | string | 否 | - | 下载某些类型附件需要在 URL 上额外带 extra 参数(飞书 API 要求时填) |
| 输出变量名 | outKey | output | 否 | attachment | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
attachment | object | { ok:true, data:{ fileToken, savedPath, fileName, size } } |
- 节点标识:
AddBitableTable - 节点说明: 在 base 内新建一个数据表,可选 defaultViewName / 初始 fields
- XML 示例:
<AddBitableTable connectionId="" url="" tableName="" outKey="table" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken(替代 url) | appToken | string | 否 | - | |
| 新表名称 | tableName | string | 是 | - | 如:订单管理 |
| 默认视图名(可选) | defaultViewName | string | 否 | - | 可选;留空则使用飞书默认视图名 |
| 初始字段(JSON 数组,可选) | fields | textarea | 否 | - | [{“field_name”:“标题”,“type”:1},{“field_name”:“金额”,“type”:2}];不传则创建一张空表 |
| 输出变量名 | outKey | output | 否 | table | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
table | object | { ok:true, data:{ tableId, defaultViewId?, fieldIdList? }, statusCode, attempts, durationMs } |
- 节点标识:
DeleteBitableTable - 节点说明: 删除一个数据表(含全部记录、视图、字段,不可恢复)
- XML 示例:
<DeleteBitableTable connectionId="" url="" tableId="" outKey="deleteResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| 要删除的 tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 输出变量名 | outKey | output | 否 | deleteResult | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
deleteResult | object | { ok:true, data:{ tableId, deleted:true } } |
重命名数据表
Section titled “重命名数据表”- 节点标识:
UpdateBitableTable - 节点说明: 修改一个数据表的名称
- XML 示例:
<UpdateBitableTable connectionId="" url="" tableId="" tableName="" outKey="table" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 新名称 | tableName | string | 是 | - | |
| 输出变量名 | outKey | output | 否 | table | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
table | object | { ok:true, data:{ tableId, name } } |
- 节点标识:
ListBitableViews - 节点说明: 列出指定 table 下的所有视图
- XML 示例:
<ListBitableViews connectionId="" url="" tableId="" outKey="views" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 每页条数 | pageSize | number | 否 | 100 | 默认 100,最大 100 |
| 最多翻页数 | maxPages | number | 否 | 50 | 防御无限循环;默认 50,上限 200 |
| 输出变量名 | outKey | output | 否 | views | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
views | object | { ok:true, data:{ items:[{viewId, viewName, viewType, property?}], total } } |
- 节点标识:
AddBitableView - 节点说明: 新建一个视图,viewType 支持 grid / kanban / gallery / gantt / form / hierarchy / calendar
- XML 示例:
<AddBitableView connectionId="" url="" tableId="" viewName="" viewType="grid" outKey="view" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 视图名称 | viewName | string | 是 | - | |
| 视图类型 | viewType | select | 否 | grid | |
| 输出变量名 | outKey | output | 否 | view | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
view | object | { ok:true, data:{ viewId, viewName, viewType } } |
- 节点标识:
DeleteBitableView - 节点说明: 删除一个视图。删除不可恢复
- XML 示例:
<DeleteBitableView connectionId="" url="" tableId="" viewId="" outKey="deleteResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| viewId | viewId | string | 是 | - | 也可在 url 中放 ?view= |
| 输出变量名 | outKey | output | 否 | deleteResult | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
deleteResult | object | { ok:true, data:{ viewId, deleted:true } } |
- 节点标识:
UpdateBitableView - 节点说明: 重命名视图或修改视图属性(property)
- XML 示例:
<UpdateBitableView connectionId="" url="" tableId="" viewId="" viewName="" outKey="view" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| viewId | viewId | string | 是 | - | vewxxxxxxxx |
| 新名称(可选) | viewName | string | 否 | - | viewName / property 至少传一个 |
| 视图属性(JSON,可选) | property | textarea | 否 | - | 视图属性配置,例如 {“filter_info”:{…}};具体字段查飞书文档 |
| 输出变量名 | outKey | output | 否 | view | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
view | object | { ok:true, data:{ viewId, viewName?, viewType? } } |
- 节点标识:
AddBitableField - 节点说明: 新建一个字段。fieldType / uiType 二选一;property 可传 JSON 配置选项
- XML 示例:
<AddBitableField connectionId="" url="" tableId="" fieldName="" fieldType="1" outKey="field" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 字段名 | fieldName | string | 是 | - | |
| 字段类型 (number) | fieldType | select | 否 | 1 | 飞书字段类型数值。fieldType 与 uiType 二选一即可 |
| uiType (string,高级) | uiType | string | 否 | - | 如 SingleSelect / MultiSelect / DateTime / Attachment …;通常仅在 fieldType 不够用时填 |
| 属性 (JSON,可选) | property | textarea | 否 | - | 字段属性配置,例如单选 {“options”:[{“name”:“待处理”,“color”:0}]} |
| 字段描述 (可选) | description | string | 否 | - | |
| 输出变量名 | outKey | output | 否 | field | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
field | object | { ok:true, data:{ fieldId, fieldName, type, uiType?, property? } } |
- 节点标识:
UpdateBitableField - 节点说明: 修改字段(重命名 / 改类型 / 改属性 / 改描述)
- XML 示例:
<UpdateBitableField connectionId="" url="" tableId="" fieldId="" fieldName="" outKey="field" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| fieldId | fieldId | string | 是 | - | fldxxxxxxxx |
| 新字段名(可选) | fieldName | string | 否 | - | fieldName / fieldType / uiType / property / description 至少传一个 |
| 新字段类型(可选) | fieldType | string | 否 | - | 数值;不改类型则留空。常用值参见 AddBitableField 的字段类型表 |
| uiType(可选) | uiType | string | 否 | - | |
| 属性(JSON,可选) | property | textarea | 否 | - | {} |
| 字段描述(可选) | description | string | 否 | - | |
| 输出变量名 | outKey | output | 否 | field | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
field | object | { ok:true, data:{ fieldId, fieldName?, type?, uiType?, property? } } |
- 节点标识:
DeleteBitableField - 节点说明: 删除一个字段(含所有记录中该字段的值,不可恢复)
- XML 示例:
<DeleteBitableField connectionId="" url="" tableId="" fieldId="" outKey="deleteResult" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | 在「设置 → 集成与连接」中配置的飞书自建应用连接 |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 要删除的 fieldId | fieldId | string | 是 | - | fldxxxxxxxx |
| 输出变量名 | outKey | output | 否 | deleteResult | |
| 失败时抛错 | failOnError | boolean | 否 | true | true:调用失败抛 节点错误 中断流程;false:失败结果写入 outKey 变量后继续往下走(需配合 if 节点判断 ok 字段) |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
deleteResult | object | { ok:true, data:{ fieldId, deleted:true, fieldName? } } |
批量更新记录
Section titled “批量更新记录”- 节点标识:
BatchUpdateBitableRecords - 节点说明: 批量更新多条记录。records 每项必须带 recordId;单批最多 1000 条,超出自动切片
- XML 示例:
<BatchUpdateBitableRecords connectionId="" url="" tableId="" records="[{\"recordId\":\"rec123\",\"状态\":\"已完成\"}]" outKey="records" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| tableId | tableId | string | 是 | - | tblxxxxxxxx |
| 要更新的记录数组 | records | json | 是 | - | 每项必须包含 recordId,其余键为字段名。例:[{“recordId”:“rec1”,“字段1”:“新值”},{“recordId”:“rec2”,“字段2”:42}] |
| userIdType | userIdType | select | 否 | open_id | |
| 跳过字段类型转换 | skipCodec | boolean | 否 | - | true: 原姗透传 fields,不根据字段元信息做类型适配 |
| 存在字段不匹配时报错 | strictCodec | boolean | 否 | - | |
| 单批大小 | batchSize | number | 否 | 500 | 默认 500,最大 1000(飞书限制) |
| 输出变量名 | outKey | output | 否 | records | |
| 失败时抛错 | failOnError | boolean | 否 | true |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
records | object | { ok:true, data:{ records:[{ recordId, fields }], total } };失败时 diagnose.hint 含已成功批次 + succeededRecordIds |
获取多维表应用元信息
Section titled “获取多维表应用元信息”- 节点标识:
GetBitableAppMeta - 节点说明: 获取 bitable app 层别的元信息(名称 / revision / 时区 / 是否启用高级权限),不需 tableId
- XML 示例:
<GetBitableAppMeta connectionId="" url="" outKey="appMeta" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | |
| 多维表格链接 | url | string | 否 | - | 与 appToken 二选一;wiki 链接会自动解析 |
| appToken | appToken | string | 否 | - | |
| 输出变量名 | outKey | output | 否 | appMeta | |
| 失败时抛错 | failOnError | boolean | 否 | true |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
appMeta | object | { ok:true, data:{ appToken, name, revision, isAdvanced?, timeZone?, formulaType? } };revision 可用于并发控制 |
修改多维表应用名称/高级权限
Section titled “修改多维表应用名称/高级权限”- 节点标识:
UpdateBitableAppMeta - 节点说明: 重命名 bitable app,或切换高级权限(需 owner 权限)。name 与 isAdvanced 至少传一个
- XML 示例:
<UpdateBitableAppMeta connectionId="" url="" name="新名称" outKey="updatedApp" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | |
| 多维表格链接 | url | string | 否 | - | |
| appToken | appToken | string | 否 | - | |
| 新名称 | name | string | 否 | - | 与 isAdvanced 至少传一个 |
| 启用高级权限 | isAdvanced | select | 否 | - | 需 app owner 权限才能修改 |
| 输出变量名 | outKey | output | 否 | updatedApp | |
| 失败时抛错 | failOnError | boolean | 否 | true |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
updatedApp | object | { ok:true, data:{ appToken, name, revision, isAdvanced? } } |
新建多维表应用
Section titled “新建多维表应用”- 节点标识:
CreateBitableApp - 节点说明: 在指定云盘文件夹下创建一个全新的多维表 app(含一个默认表)
- XML 示例:
<CreateBitableApp connectionId="" name="销售管理" folderToken="" outKey="newApp" />| 界面名称 | 代码属性名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|---|
| 飞书连接 | connectionId | connection | 是 | - | |
| 多维表名称 | name | string | 是 | - | 销售管理 |
| 目标文件夹 token | folderToken | string | 否 | - | 不传则建在应用根目录;可在云盘 URL 的 /folder/<token> 提取 |
| 时区 | timeZone | string | 否 | - | 不传默认跟随用户时区 |
| 输出变量名 | outKey | output | 否 | newApp | |
| 失败时抛错 | failOnError | boolean | 否 | true |
输出字段:
| 字段 | 类型 | 说明 |
|---|---|---|
newApp | object | { ok:true, data:{ appToken, name, folderToken?, url?, defaultTableId?, timeZone? } } |
- 节点运行状态为成功。
- 输出变量中包含预期字段,且可被下游节点引用。
- 对外部系统有写入动作的节点,目标系统中的数据状态与配置一致。
| 现象 / 报错 | 可能原因 | 处理建议 |
|---|---|---|
| 找不到插件分组 | 插件未安装、未加载或当前端不是桌面客户端 | 在「扩展能力」中刷新/重新扫描插件,必要时重启客户端。 |
| 连接或鉴权失败 | 连接配置缺失、令牌过期或权限不足 | 重新配置连接,确认账号具备对应资源权限。 |
| 查询结果为空 | 筛选条件过窄、目标资源为空或页面状态不正确 | 放宽条件,检查资源 ID、日期范围和页面登录态。 |
| 写入类操作失败 | 参数格式不符合平台要求或目标资源不可写 | 先用少量测试数据验证,再检查必填字段、ID 和权限。 |
- 插件能力由桌面端扩展能力机制加载,和普通后端指令树不是同一数据源。
- 插件页按插件维度整理;每个节点的帮助入口会跳到所属插件页,页面内可查节点标识、参数和输出。