79 lines
5.6 KiB
Markdown
79 lines
5.6 KiB
Markdown
# 更新数据表
|
||
|
||
更新数据表的名称。
|
||
|
||
## 请求
|
||
|
||
基本 |
|
||
---|---
|
||
HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables/:table_id
|
||
HTTP Method | PATCH
|
||
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
|
||
支持的应用类型 | Custom App、Store App
|
||
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 更新数据表(base:table:update)<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"
|
||
|
||
### 路径参数
|
||
|
||
名称 | 类型 | 描述
|
||
---|---|---
|
||
app_token | string | 多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同：<br>- 如果多维表格的 URL 以 ==**feishu.cn/base**== 开头，该多维表格的 `app_token` 是下图高亮部分：<br><br>- 如果多维表格的 URL 以 ==**feishu.cn/wiki**== 开头，你需调用知识库相关[获取知识空间节点信息](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/wiki-v2/space/get_node)接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。<br>了解更多，参考[多维表格 app_token 获取方式](https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/bitable-overview#-752212c)。<br>**示例值**："XrgTb4y1haKYnasu0xXb1g7lcSg"<br>**数据校验规则**：<br>- 最小长度：`1` 字符
|
||
table_id | string | 多维表格数据表的唯一标识。获取方式：<br>- 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id`<br>- 也可通过[列出数据表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list)接口获取 `table_id`<br><br>**示例值**："tbl1TkhyTWDkSoZ3"
|
||
|
||
### 请求体
|
||
|
||
名称 | 类型 | 必填 | 描述
|
||
---|---|---|---
|
||
name | string | 否 | 数据表的新名称。<br>**注意**：<br>- 名称中的首尾空格将会被去除。<br>- 数据表名称不可以包含 `/ \ ? * : [ ]` 等特殊字符。<br>- 如果名称为空或和旧名称相同，接口仍然会返回成功，但是名称不会被更改。<br>**示例值**："新的数据表名称"<br>**数据校验规则**：<br>- 长度范围：`1` ～ `100` 字符<br>- 正则校验：`^[^\[\]\:\\\/\?\*]+$`
|
||
|
||
### 请求体示例
|
||
```json
|
||
{
|
||
"name": "新的数据表名称"
|
||
}
|
||
```
|
||
|
||
## 响应
|
||
|
||
### 响应体
|
||
|
||
名称 | 类型 | 描述
|
||
---|---|---
|
||
code | int | 错误码，非 0 表示失败
|
||
msg | string | 错误描述
|
||
data | \- | \-
|
||
name | string | 新的数据表名称
|
||
|
||
### 响应体示例
|
||
```json
|
||
{
|
||
"code": 0,
|
||
"msg": "success",
|
||
"data": {
|
||
"name": "新的数据表名称"
|
||
}
|
||
}
|
||
```
|
||
|
||
### 错误码
|
||
|
||
HTTP状态码 | 错误码 | 描述 | 排查建议
|
||
---|---|---|---
|
||
400 | 1254001 | WrongRequestBody | 请求体错误
|
||
400 | 1254002 | Fail | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|
||
400 | 1254003 | WrongBaseToken | app_token 错误
|
||
400 | 1254004 | WrongTableId | table_id 错误
|
||
400 | 1254013 | TableNameDuplicated | 表名重复
|
||
403 | 1254036 | Base is copying, please try again later. | 复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
|
||
404 | 1254040 | BaseTokenNotFound | app_token 不存在
|
||
404 | 1254041 | TableIdNotFound | table_id 不存在
|
||
429 | 1254290 | TooManyRequest | 请求过快，稍后重试
|
||
403 | 1254302 | Permission denied. | 调用身份缺少多维表格的高级权限。你需要为调用身份授予高级权限：<br>- 对用户授予高级权限，你需要在多维表格页面右上方 **分享** 入口为当前用户添加可管理权限。<br>- 对应用授予高级权限，你需通过多维表格页面右上方 **「...」** -> **「...更多」** ->**「添加文档应用」** 入口为应用添加可管理权限。<br><br><br>**注意**：<br>在 **添加文档应用** 前，你需确保目标应用至少开通了一个多维表格的 [API 权限](https://open.feishu.cn/document/ukTMukTMukTM/uYTM5UjL2ETO14iNxkTN/scope-list)。否则你将无法在文档应用窗口搜索到目标应用。 <br>- 你也可以在 **多维表格高级权限设置** 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。
|
||
500 | 1255001 | InternalError | 内部错误，请联系[技术支持](https://applink.feishu.cn/TLJpeNdW)
|