125 lines
7.2 KiB
Markdown
125 lines
7.2 KiB
Markdown
# 创建多维表格
|
||
|
||
在指定文件夹中创建一个多维表格，包含一个空白的数据表。
|
||
|
||
**注意事项**：要基于模板创建多维表格，可先获取模板多维表格 `app_token` 作为文件 token，再调用[复制文件](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/copy)接口创建多维表格。
|
||
|
||
## 请求
|
||
|
||
基本 |
|
||
---|---
|
||
HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps
|
||
HTTP Method | POST
|
||
接口频率限制 | [20 次/分钟](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
|
||
支持的应用类型 | Custom App、Store App
|
||
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 创建多维表格(base:app:create)<br>查看、评论、编辑和管理多维表格(bitable:app)
|
||
|
||
### 请求头
|
||
|
||
名称 | 类型 | 必填 | 描述
|
||
---|---|---|---
|
||
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
|
||
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"
|
||
|
||
### 请求体
|
||
|
||
名称 | 类型 | 必填 | 描述
|
||
---|---|---|---
|
||
name | string | 否 | 多维表格 App 名称。最长为 255 个字符。<br>**示例值**："一篇新的多维表格"
|
||
folder_token | string | 否 | 多维表格 App 归属文件夹。默认为空，表示多维表格将被创建在云空间根目录。了解如何获取文件夹 Token，参考[如何获取云文档资源相关 Token](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)。<br>**注意**：<br>请确保调用身份拥有在该文件夹中的编辑权限。若应用使用的是 `tenant_access_token` 权限，此处仅可指定应用创建的文件夹。详情参考[如何为应用开通云文档相关资源的权限](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-add-permissions-to-app)。<br>**示例值**："fldcnqquW1svRIYVT2Np6Iabcef"
|
||
time_zone | string | 否 | 文档时区，详情参考[文档时区介绍](https://feishu.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf)。<br>**示例值**："Asia/Macau"
|
||
|
||
### 请求体示例
|
||
```json
|
||
{
|
||
"name":"一篇新的多维表格",
|
||
"folder_token": "fldcnqquW1svRIYVT2Np6Iabcef"
|
||
}
|
||
```
|
||
|
||
## 响应
|
||
|
||
### 响应体
|
||
|
||
名称 | 类型 | 描述
|
||
---|---|---
|
||
code | int | 错误码，非 0 表示失败
|
||
msg | string | 错误描述
|
||
data | \- | \-
|
||
app | app | 返回响应体
|
||
app_token | string | 多维表格的唯一标识 app_token
|
||
name | string | 多维表格的名称
|
||
folder_token | string | 多维表格 App 归属文件夹
|
||
url | string | 多维表格 App 的 URL 链接
|
||
default_table_id | string | 默认创建的数据表 ID
|
||
time_zone | string | 文档时区
|
||
|
||
### 响应体示例
|
||
```json
|
||
{
|
||
"code": 0,
|
||
"data": {
|
||
"app": {
|
||
"app_token": "S404b*****e9PQsYDWYcNryFn0g",
|
||
"default_table_id": "tbl********oumSQ",
|
||
"folder_token": "fldcnqquW1svRIYVT2Np6Iabcef",
|
||
"name": "一篇新的多维表格",
|
||
"url": "https://example.feishu.cn/base/S404b*****e9PQsYDWYcNryFn0g"
|
||
}
|
||
},
|
||
"msg": "success"
|
||
}
|
||
```
|
||
|
||
### 错误码
|
||
|
||
HTTP状态码 | 错误码 | 描述 | 排查建议
|
||
---|---|---|---
|
||
200 | 1254000 | WrongRequestJson | 请求体错误
|
||
200 | 1254001 | WrongRequestBody | 请求体错误
|
||
200 | 1254002 | Fail | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
200 | 1254003 | WrongBaseToken | app_token 错误
|
||
200 | 1254004 | WrongTableId | table_id 错误
|
||
200 | 1254005 | WrongViewId | view_id 错误
|
||
200 | 1254006 | WrongRecordId | 检查 record_id
|
||
200 | 1254007 | EmptyValue | 空值
|
||
200 | 1254008 | EmptyView | 空视图
|
||
200 | 1254009 | WrongFieldId | 字段 id 错误
|
||
200 | 1254010 | ReqConvError | 请求错误
|
||
200 | 1254025 | InvalidCopyTypes | Copy Type参数无效
|
||
200 | 1254030 | TooLargeResponse | 响应体过大
|
||
400 | 1254031 | InvalidAppName | 名称不能超过255个字符
|
||
400 | 1254036 | Base is copying, please try again later. | 复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
|
||
200 | 1254040 | BaseTokenNotFound | app_token 不存在
|
||
200 | 1254041 | TableIdNotFound | table_id 不存在
|
||
200 | 1254042 | ViewIdNotFound | view_id 不存在
|
||
200 | 1254043 | RecordIdNotFound | record_id 不存在
|
||
200 | 1254044 | FieldIdNotFound | field_id 不存在
|
||
200 | 1254060 | TextFieldConvFail | 多行文本字段错误
|
||
200 | 1254061 | NumberFieldConvFail | 数字字段错误
|
||
200 | 1254062 | SingleSelectFieldConvFail | 单选字段错误
|
||
200 | 1254063 | MultiSelectFieldConvFail | 多选字段错误
|
||
200 | 1254064 | DatetimeFieldConvFail | 日期字段错误
|
||
200 | 1254065 | CheckboxFieldConvFail | 复选框字段错误
|
||
200 | 1254066 | UserFieldConvFail | 人员字段有误。原因可能是：<br>- `user_id_type` 参数指定的 ID 类型与传入的 ID 类型不匹配<br>- 传入了不识别的类型或结构，目前只支持填写 `id` 参数，且需要传入数组<br>- 跨应用传入了 `open_id`。如果跨应用传入 ID，建议使用 `user_id`。不同应用获取的 `open_id` 不能交叉使用
|
||
200 | 1254067 | LinkFieldConvFail | 关联字段错误
|
||
200 | 1254100 | TableExceedLimit | 数据表或仪表盘数量超限。每个多维表格中，数据表加仪表盘的数量最多为 100 个
|
||
200 | 1254101 | ViewExceedLimit | 视图数量超限，限制 200 个，包括公共视图、锁定视图和个人视图（即只有视图所有者才能看到的视图）
|
||
200 | 1254102 | FileExceedLimit | 文档数量超限
|
||
200 | 1254103 | RecordExceedLimit | 记录数量超限，限制 20,000 条
|
||
200 | 1254104 | RecordAddOnceExceedLimit | 单次添加记录数量超限，限制 500 条
|
||
200 | 1254130 | TooLargeCell | 格子内容过大
|
||
200 | 1254290 | TooManyRequest | 请求过快，稍后重试
|
||
200 | 1254291 | Write conflict | 同一个数据表 (table) 不支持并发调用写接口，请检查是否存在并发调用写接口。写接口包括：新增、修改、删除记录；新增、修改、删除字段；修改表单；修改视图等。
|
||
200 | 1254301 | OperationTypeError | 多维表格未开启高级权限或不支持开启高级权限
|
||
200 | 1254304 | PermNotAllow | 仅企业版和旗舰版飞书支持行列权限
|
||
403 | 1254701 | DriveNodePermNotAllow | 对目标云空间节点没有权限
|
||
404 | 1254702 | DriveNodeNotExist | 云空间节点不存在，检查参数正确性
|
||
400 | 1254800 | InvalidParameter | 参数错误，请根据msg修正后重试
|
||
200 | 1255001 | InternalError | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
200 | 1255002 | RpcError | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
200 | 1255003 | MarshalError | 序列化错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
200 | 1255004 | UmMarshalError | 反序列化错误
|
||
200 | 1255005 | ConvError | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
504 | 1255040 | 请求超时 | 进行重试
|