108 lines
4.8 KiB
Markdown
108 lines
4.8 KiB
Markdown
# 更新多维表格元数据
|
||
|
||
更新多维表格元数据，包括多维表格的名称、是否开启高级权限。
|
||
|
||
## 注意事项
|
||
|
||
- 在线文档和电子表格中嵌入的多维表格、知识库中的多维表格不支持开启高级权限。
|
||
- 此接口非原子操作，先修改多维表格名称，后开关高级权限，可能存在部分成功的情况。
|
||
|
||
## 请求
|
||
|
||
基本 |
|
||
---|---
|
||
HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token
|
||
HTTP Method | PUT
|
||
接口频率限制 | [10 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
|
||
支持的应用类型 | Custom App、Store App
|
||
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用**<br>开启任一权限即可 | 更新多维表格(base:app: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 token。该接口仅支持存储在云空间文件夹中的多维表格，即 URL 以 **feishu.cn/base** 开头的多维表格形态。该类多维表格的 app_token 为 URL 下图高亮部分：<br><br>**示例值**："appbcbWCzen6D8dezhoCH2RpMAh"
|
||
|
||
### 请求体
|
||
|
||
名称 | 类型 | 必填 | 描述
|
||
---|---|---|---
|
||
name | string | 否 | 新的多维表格名称，不传则不更新名称。<br>**示例值**："新的多维表格名称"
|
||
is_advanced | boolean | 否 | 多维表格是否开启高级权限。不传则不更新设置。可选值：<br>- true：开启高级权限<br>- false：关闭高级权限<br>**示例值**：true
|
||
|
||
### 请求体示例
|
||
```json
|
||
{
|
||
"name": "新的多维表格名称",
|
||
"is_advanced": true
|
||
}
|
||
```
|
||
|
||
## 响应
|
||
|
||
### 响应体
|
||
|
||
名称 | 类型 | 描述
|
||
---|---|---
|
||
code | int | 错误码，非 0 表示失败
|
||
msg | string | 错误描述
|
||
data | \- | \-
|
||
app | display_app_v2 | 多维表格元数据
|
||
app_token | string | 多维表格的唯一标识 app_token
|
||
name | string | 多维表格的名称
|
||
is_advanced | boolean | 多维表格是否已开启高级权限
|
||
time_zone | string | 文档时区
|
||
|
||
### 响应体示例
|
||
```json
|
||
{
|
||
"code": 0,
|
||
"msg": "success",
|
||
"data": {
|
||
"app": {
|
||
"app_token": "appbcbWCzen6D8dezhoCH2RpMAh",
|
||
"name": "新的多维表格名字",
|
||
"is_advanced": true
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### 错误码
|
||
|
||
HTTP状态码 | 错误码 | 描述 | 排查建议
|
||
---|---|---|---
|
||
200 | 1254000 | WrongRequestJson | 请求体错误
|
||
200 | 1254001 | WrongRequestBody | 请求体错误
|
||
200 | 1254002 | Fail | 内部错误，有疑问可咨询客服
|
||
200 | 1254003 | WrongBaseToken | app_token 错误
|
||
200 | 1254010 | ReqConvError | 请求错误
|
||
200 | 1254031 | InvalidAppName | 多维表格名称格式错误，长度不超过 100 个字符，不能包含 ? / \ * : [ ]
|
||
400 | 1254036 | Base is copying, please try again later. | 多维表格副本复制中，稍后重试
|
||
200 | 1254040 | BaseTokenNotFound | app_token 不存在
|
||
200 | 1254043 | RecordIdNotFound | record_id 不存在
|
||
200 | 1254200 | internal error | 内部错误
|
||
200 | 1254290 | TooManyRequest | 请求过快，稍后重试
|
||
200 | 1254291 | Write conflict | 同一个数据表(table) 不支持并发调用写接口，请检查是否存在并发调用写接口。写接口包括：新增、修改、删除记录；新增、修改、删除字段；修改表单；修改视图等。
|
||
400 | 1254301 | OperationTypeError | 多维表格未开启高级权限或不支持开启高级权限
|
||
403 | 1254302 | Permission denied. | 无访问权限, 常由表格开启了高级权限造成, 请在高级权限设置中添加一个包含应用的群, 给予这个群读写权限
|
||
403 | 1254304 | The role has no permissions. | 无权限
|
||
200 | 1255001 | InternalError | 内部错误，有疑问可咨询客服
|
||
200 | 1255002 | RpcError | 内部错误，有疑问可咨询客服
|
||
200 | 1255003 | MarshalError | 序列化错误，有疑问可咨询客服
|
||
200 | 1255004 | UmMarshalError | 反序列化错误
|
||
504 | 1255040 | 请求超时 | 进行重试
|
||
|
||
## 补充错误码
|
||
|
||
**错误码** | **原因** | **排查建议** |
|
||
| ------- | ------- | ----------------- |
|
||
| 1254061 | 字段格式错误。 | 确认对应字段类型参数格式是否正确。
|