更新筛选

在电子表格工作表筛选范围中，更新指定列的筛选条件。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter
HTTP Method	PUT
接口频率限制	20 次/分钟
支持的应用类型	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"

请求体

名称	类型	必填	描述
col	string	是	指定要更新筛选条件的列。 示例值："G"
condition	condition	是	设置筛选条件。
└ filter_type	string	是	筛选类型，枚举值如下所示。了解更多，参考筛选指南。 - multiValue ：多值筛选 - number ：数字筛选 - text ：文本筛选 - color ：颜色筛选 - clear ：清除某列的筛选条件 示例值："text"
└ compare_type	string	否	比较类型。不同筛选类型的比较类型的枚举值不同，详情参考筛选指南。 示例值："beginsWith"
└ expected	string\[\]	是	筛选参数。不同筛选类型的筛选参数限制不同，详情参考筛选指南。 示例值：["a"]

请求体示例

{
    "col": "G",
    "condition": {
        "filter_type": "text",
        "compare_type": "beginsWith",
        "expected": [
            "a"
        ]
    }
}

cURL 请求示例

curl --location --request PUT 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtcnSUVpFeJ7Q2yVN9/sheets/6e2914/filter' \
--header 'Authorization: Bearer t-719d578dc63f6bd37e30cdb0394798a709070fec' \
--header 'Content-Type: application/json' \
--data-raw '{
    "col": "G",
    "condition": {
        "filter_type": "text",
        "compare_type": "beginsWith",
        "expected": ["a"]
    }
}'

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
200	1310234	Marshal Error	服务内部错误，详询客服
400	1310235	Retry Later	请求超时，一般是由于服务器任务过多。请稍后重试
500	1315203	Server Error	服务内部错误，详询客服
500	1315201	Server Error	服务内部错误，详询客服
400	1310226	Excess Limit	超出限制。请参考响应体中的错误提示排查
400	1310215	Sheet Id Not Found	工作表未找到。检查工作表的 ID 是否正确。获取方式见获取工作表
400	1310214	SpreadSheet Not Found	表格未找到。检查表格 token 是否正确。可通过以下两种方式获取。了解更多，参考电子表格概述。 - 电子表格的 URL：https://sample.feishu.cn/sheets/==Iow7sNNEphp3WbtnbCscPqabcef== - 调用获取文件夹中的文件清单
400	1310218	Locked Cell	筛选范围被保护。请取消保护范围后再筛选
400	1310213	Permission Fail	没有文档相应权限。参考云文档常见问题问题 2 和问题 3 开通应用权限和文档权限
400	1310206	Empty Sheet Id	工作表 ID 为空。请填写工作表的 ID。获取方式见获取工作表
400	1310229	Wrong URL Param	URL 中的路径参数错误。请检查路径参数
400	1310202	Wrong Range	区域范围错误。请检查 range 参数
400	1310236	Wrong Filter Value	筛选条件错误。请检查筛选条件
400	1310211	Wrong Sheet Id	工作表 ID 错误。请检查工作表的 ID 是否正确。获取方式见获取工作表
400	1310242	In Mix state	当前表格数据位于用户机房，正在将数据恢复到 SaaS 环境中，请稍后重试
400	1310249	Spreadsheet Deleted	表格已被删除。请恢复表格后重试