获取视图
根据视图 ID 获取现有视图信息,包括视图名称、类型、属性等。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables/:table_id/views/:view_id |
| HTTP Method | GET |
| 接口频率限制 | 20 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | base:view:read 检索视图 bitable:app 查看、评论、编辑和管理多维表格 bitable:app:readonly 查看、评论和导出多维表格 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
app_token | string | 多维表格 App 的唯一标识。不同形态的多维表格,其 app_token 的获取方式不同: - 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分: ![]() - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token。了解更多,参考多维表格 app_token 获取方式。 示例值:"bascnCMII2ORej2RItqpZZUNMIe" 数据校验规则: - 最小长度: 1 字符 |
table_id | string | 多维表格数据表的唯一标识。获取方式: - 你可通过多维表格 URL 获取 table_id,下图高亮部分即为当前数据表的 table_id - 也可通过列出数据表接口获取 table_id![]() 示例值:"tblsRc9GRRXKqhvW" |
view_id | string | 多维表格中视图的唯一标识。获取方式: - 在多维表格的 URL 地址栏中, view_id 是下图中高亮部分: - 通过列出视图接口获取。暂时无法获取到嵌入到云文档中的多维表格的 view_id。注意: 当 filter 参数 或 sort 参数不为空时,请求视为对数据表中的全部数据做条件过滤,指定的 view_id 会被忽略。示例值:"vewTpR1urY" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ view | app.table.view | 视图信息 |
└ view_id | string | 视图 ID |
└ view_name | string | 视图名称 |
└ view_type | string | 视图类型 可选值有: - grid:表格视图- kanban:看板视图- gallery:画册视图- gantt:甘特视图- form:表单视图 |
└ property | app.table.view.property | 视图属性 |
└ filter_info | app.table.view.property.filter_info | 过滤条件 |
└ conjunction | string | 多个筛选条件的关系 可选值有: - and: 与 - or: 或 |
└ conditions | app.table.view.property.filter_info.condition\[\] | 筛选条件 |
└ field_id | string | 用于过滤的字段的唯一标识 |
└ operator | string | 过滤操作的类型 可选值有: - is: 等于 - isNot: 不等于 - contains: 包含 - doesNotContain: 不包含 - isEmpty: 为空 - isNotEmpty: 不为空 - isGreater: 大于 - isGreaterEqual: 大于等于 - isLess: 小于 - isLessEqual: 小于等于 |
└ value | string | 筛选值 |
└ condition_id | string | 过滤条件的 ID |
└ field_type | int | 用于过滤的字段类型 - 1:多行文本 - 2:数字 - 3:单选 - 4:多选 - 5:日期 - 7:复选框 - 11:人员 - 13:电话号码 - 15:超链接 - 17:附件 - 18:单向关联 - 19:查找引用 - 20:公式 - 21:双向关联 - 22:地理位置 - 23:群组 - 1001:创建时间 - 1002:最后更新时间 - 1003:创建人 - 1004:修改人 - 1005:自动编号 |
└ condition_omitted | boolean | 筛选条件是否缺省 |
└ hidden_fields | string\[\] | 隐藏字段 ID 列表 |
└ hierarchy_config | app.table.view.property.hierarchy_config | 表格视图层级结构设置 |
└ field_id | string | 层级结构的关联列 ID |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"view": {
"view_id": "vewsOleexJ",
"view_name": "grid",
"view_type": "grid",
"property": {
"filter_info": {
"condition_omitted": null,
"conditions": [
{
"condition_id": "conuKMQNNg",
"field_id": "fldVioUai1",
"field_type": 1,
"operator": "is",
"value": "[\"text content\"]"
}
],
"conjunction": "and"
},
"hidden_fields": null
}
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1254000 | WrongRequestJson | 请求体错误 |
| 400 | 1254001 | WrongRequestBody | 请求体错误 |
| 400 | 1254002 | Fail | 导致报 1254002 错误码的场景较多,请参考以下排查建议排查: - 如果日志内容显示 changeset size exceed the limit, len:xxxxx,表示单次操作的内容变更较大,你需要在单次操作中减少数据量 - 如果日志内容显示 lock not obtained 或 data not ready,表示并发调用接口导致抢锁失败出错。你需控制请求间隔,稍后重试 - 如果在知识库(wiki)中创建多维表格,请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如,在分页查询多维表格时,传递了无效的 page_token,或传递了错误的数据表的 table_id - 如果该报错偶尔发生,可能是服务器超时或不稳定,请重试解决 |
| 400 | 1254003 | WrongBaseToken | app_token 错误 |
| 400 | 1254004 | WrongTableId | table_id 错误 |
| 400 | 1254005 | WrongViewId | view_id 错误 |
| 400 | 1254006 | WrongRecordId | 检查 record_id |
| 400 | 1254007 | EmptyValue | 空值 |
| 400 | 1254008 | EmptyView | 空视图 |
| 400 | 1254009 | WrongFieldId | 字段 id 错误 |
| 400 | 1254010 | ReqConvError | 请求错误 |
| 400 | 1254016 | InvalidSort | Sort参数错误 |
| 400 | 1254018 | InvalidFilter | filter 参数错误。请参考记录过滤参数填写指南了解如何填写 filter 参数。 |
| 400 | 1254019 | InvalidViewType | 视图类型无效 |
| 400 | 1254020 | ViewNameDuplicated | 视图名重复 |
| 400 | 1254021 | EmptyViewName | 视图名为空 |
| 400 | 1254022 | InvalidViewName | 视图名无效 |
| 400 | 1254030 | TooLargeResponse | 响应体过大 |
| 400 | 1254032 | The role name is invalid, please modify it. | 自定义角色名无效 |
| 400 | 1254033 | The role name is duplicated, please modify it. | 自定义角色名重复 |
| 400 | 1254036 | Base is copying, please try again later. | 复制多维表格为异步操作,该错误码表示当前多维表格仍在复制中,在复制期间无法操作当前多维表格。需要等待复制完成后再操作 |
| 404 | 1254040 | BaseTokenNotFound | app_token 不存在 |
| 404 | 1254041 | TableIdNotFound | table_id 不存在 |
| 404 | 1254042 | ViewIdNotFound | view_id 不存在 |
| 404 | 1254043 | RecordIdNotFound | record_id 不存在 |
| 404 | 1254044 | FieldIdNotFound | field_id 不存在 |
| 404 | 1254045 | FieldNameNotFound | 字段名称不存在。请检查: - 接口中字段名称和多维表格中的字段名称是否完全匹配。如果难以排查,建议你调用列出字段接口获取字段名称,因为根据表格页面的 UI 名称可能会忽略空格、换行或特殊符号等差异。 - 表格是否开启了高级权限但调用身份缺少对应字段的权限。你需要为调用身份授予高级权限: - 对用户授予高级权限,你需要在多维表格页面右上方 分享 入口为当前用户添加可管理权限。 - 对应用授予高级权限,你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 注意: 在 添加文档应用 前,你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。 |
| 404 | 1254047 | Role id is not found. | role_id 不存在 |
| 400 | 1254048 | MemberNotFound | member 不存在 |
| 404 | 1254049 | Form field is not found. | form_field_id 不存在 |
| 400 | 1254060 | TextFieldConvFail | 多行文本字段错误 |
| 400 | 1254061 | NumberFieldConvFail | 数字字段错误 |
| 400 | 1254062 | SingleSelectFieldConvFail | 单选字段错误 |
| 400 | 1254063 | MultiSelectFieldConvFail | 多选字段错误 |
| 400 | 1254064 | DatetimeFieldConvFail | 日期字段错误 |
| 400 | 1254065 | CheckboxFieldConvFail | 复选框字段错误 |
| 400 | 1254066 | UserFieldConvFail | 人员字段有误。原因可能是: - user_id_type 参数指定的 ID 类型与传入的 ID 类型不匹配 - 传入了不识别的类型或结构,目前只支持填写 id 参数,且需要传入数组 - 跨应用传入了 open_id。如果跨应用传入 ID,建议使用 user_id。不同应用获取的 open_id 不能交叉使用 |
| 400 | 1254067 | LinkFieldConvFail | 关联字段错误 |
| 400 | 1254100 | TableExceedLimit | 数据表或仪表盘数量超限。每个多维表格中,数据表加仪表盘的数量最多为 100 个 |
| 400 | 1254101 | ViewExceedLimit | 视图数量超限, 限制200个 |
| 400 | 1254103 | RecordExceedLimit | 记录数量超限, 限制20,000条 |
| 400 | 1254104 | RecordAddOnceExceedLimit | 单次添加记录数量超限, 限制500条 |
| 400 | 1254110 | Role exceeds limit | 自定义角色数量超限,限制30条 |
| 400 | 1254130 | TooLargeCell | 格子内容过大 |
| 429 | 1254290 | TooManyRequest | 请求过快,稍后重试 |
| 400 | 1254291 | Write conflict | 同一个数据表(table) 不支持并发调用写接口,请检查是否存在并发调用写接口。写接口包括:新增、修改、删除记录;新增、修改、删除字段;修改表单;修改视图等。 |
| 400 | 1254301 | OperationTypeError | 多维表格未开启高级权限或不支持开启高级权限 |
| 403 | 1254302 | Permission denied. | 调用身份缺少多维表格的高级权限。你需要为调用身份授予高级权限: - 对用户授予高级权限,你需要在多维表格页面右上方 分享 入口为当前用户添加可管理权限。 - 对应用授予高级权限,你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。 注意: 在 添加文档应用 前,你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在 多维表格高级权限设置 中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。 |
| 500 | 1255001 | InternalError | 内部错误,请联系技术支持 |
| 500 | 1255002 | RpcError | 内部错误,请联系技术支持 |
| 500 | 1255003 | MarshalError | 序列化错误,请联系技术支持 |
| 500 | 1255004 | UmMarshalError | 反序列化错误 |
| 500 | 1255005 | ConvError | 内部错误,请联系技术支持 |
| 504 | 1255040 | 请求超时 | 进行重试 |
| 400 | 1254607 | Data not ready, please try again later. | 该报错一般是由于前置操作未执行完成,或本次操作数据太大,服务器计算超时导致。遇到该错误码时,建议等待一段时间后重试。通常有以下几种原因: - 编辑操作频繁:开发者对多维表格的编辑操作非常频繁。可能会导致由于等待前置操作处理完成耗时过长而超时的情况。多维表格底层对数据表的处理基于版本维度的串行方式,不支持并发。因此,并发请求时容易出现此类错误,不建议开发者对单个数据表进行并发请求。 - 批量操作负载重:开发者在多维表格中进行批量新增、删除等操作时,如果数据表的数据量非常大,可能会导致单次请求耗时过长,最终导致请求超时。建议开发者适当降低批量请求的 page_size 以减少请求耗时。 - 资源分配与计算开销:资源分配是基于单文档维度的,如果读接口涉及公式计算、排序等计算逻辑,会占用较多资源。例如,并发读取一个文档下的多个数据表也可能导致该文档阻塞。 |



- 通过
- 对应用授予高级权限,你需通过多维表格页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加可管理权限。
注意: 在 添加文档应用 前,你需确保目标应用至少开通了一个多维表格的