更新筛选视图
更新筛选视图的名称或筛选范围。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id |
| HTTP Method | PATCH |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token |
| Content-Type | string | 是 | 固定值："application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
spreadsheet_token | string | 电子表格的 token。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 示例值："Iow7sNNEphp3WbtnbCscPqabcef" |
sheet_id | string | 工作表 ID，通过获取工作表 获取。 示例值："8fe9d6" |
filter_view_id | string | 筛选视图 ID。通过查询筛选视图获取。 示例值："pH9hbVcCXA" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
filter_view_name | string | 否 | 筛选视图名称。长度不得超过 100 个字符，且在工作表内必须唯一。 示例值："筛选视图 1" |
range | string | 否 | 筛选视图的筛选范围。支持以下五种写法，了解更多，参考筛选指南。 - sheetId：填写实际的工作表 ID，表示将筛选应用于整表 - sheetId!1:2 ：填写工作表 ID 和行数区间，表示将筛选应用于整行 - sheetId!A:B ：填写工作表 ID 和列的区间，表示将筛选应用于整列 - sheetId!A1:B2 ：填写工作表 ID 和单元格区间，表示将筛选应用于单元格选定的区域中 - sheetId!A1:C ：填写工作表 ID、起始单元格和结束列，表示省略结束行，使用表格的最后行作为结束行 示例值："8fe9d6!C1:H14" |
请求体示例
json
{
"filter_view_name": "筛选视图 1",
"range": "8fe9d6!C1:H14"
}cURL 请求示例
curl --location --request PATCH 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtcnspY6YDVPxWjhG09Qxxxxxx/sheets/phwh0X/filter_views/1234567890' \
--header 'Authorization: Bearer t-2602ac1d050a2a308ab8a98639d25cbaaaf26c9f' \
--header 'Content-Type: application/json' \
--data-raw '{
"range": "phwh0X!C1:J20"
}'响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ filter_view | filter_view | 更新后的筛选视图的信息 |
└ filter_view_id | string | 筛选视图 ID |
└ filter_view_name | string | 筛选视图名称 |
└ range | string | 筛选视图的筛选范围 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"filter_view": {
"filter_view_id": "pH9hbVcCXA",
"filter_view_name": "筛选视图 1",
"range": "8fe9d6!C1:H14"
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1310211 | Wrong Sheet Id | 工作表 ID 错误。请检查工作表的 ID 是否正确。获取方式见获取工作表 |
| 400 | 1310232 | Wrong Style | 样式错误，包括颜色、字体等。请修改 |
| 400 | 1310237 | Wrong Filter View Id | 筛选视图 ID 错误。请参考查询筛选视图获取正确的 ID |
| 400 | 1310239 | Wrong Filter View Name | 筛选视图名字错误。请修改 |
| 400 | 1310240 | Exist Filter View Name | 筛选视图名称已存在。请修改 |
| 400 | 1310202 | Wrong Range | 区域范围错误。请检查 range 参数 |
| 400 | 1310229 | Wrong URL Param | URL 中路径参数错误。请检查 URL 中的路径参数 |
| 400 | 1310204 | Wrong Request Body | 请求体参数错误。请参考响应体中的错误提示 |
| 400 | 1310213 | Permission Fail | 没有文档相应权限。参考云文档常见问题问题 2 和问题 3 开通应用权限和文档权限 |
| 400 | 1310218 | Locked Cell | 筛选范围被保护。请取消保护范围后再筛选 |
| 400 | 1310214 | SpreadSheet Not Found | 表格未找到。检查表格 token 是否正确。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单 |
| 400 | 1310215 | Sheet Id Not Found | 工作表未找到。检查工作表的 ID 是否正确。获取方式见获取工作表 |
| 400 | 1310217 | Too Many Request | 请求过于频繁。请稍后重试 |
| 400 | 1310235 | Retry Later | 请求超时，一般是由于服务器任务过多。请稍后重试 |
| 500 | 1315201 | Server Error | 服务内部错误，详询客服 |
| 500 | 1315203 | Server Error | 服务内部错误，详询客服 |
| 400 | 1310242 | In Mix state | 当前表格数据位于用户机房，正在将数据恢复到 SaaS 环境中，请稍后重试 |
| 400 | 1310249 | Spreadsheet Deleted | 表格已被删除。请恢复表格后重试 |