创建筛选条件

在筛选视图的指定列创建筛选条件，包括筛选的类型、比较类型、筛选参数等。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/:spreadsheet_token/sheets/:sheet_id/filter_views/:filter_view_id/conditions
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 sheets:spreadsheet 查看、评论、编辑和管理电子表格 sheets:spreadsheet:write_only 编辑电子表格

请求头

名称	类型	必填	描述
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"

请求体

名称	类型	必填	描述
condition_id	string	否	设置筛选条件的列，用字母表示。 示例值："E"
filter_type	string	否	筛选类型。枚举值如下所示。了解更多，参考筛选条件指南。 - multiValue ：多值筛选 - number：数字筛选 - text：文本筛选 - color：颜色筛选 示例值："number"
compare_type	string	否	比较类型。了解更多，参考筛选条件指南。 示例值："less"
expected	string\[\]	否	筛选参数。了解更多，参考筛选条件指南。 示例值：["6"]

请求体示例

{
    "condition_id": "E",
    "filter_type": "number",
    "compare_type": "less",
    "expected": [
        "6"
    ]
}

cURL 请求示例

curl --location --request POST 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets/shtcnspY6YDVPxWjhG09Qxxxxxx/sheets/phwh0X/filter_views/1234567890/conditions' \
--header 'Authorization: Bearer t-40cdeb051222f889f4229de856517992260aa850' \
--header 'Content-Type: application/json' \
--data-raw '{
    "condition_id": "G",
    "filter_type": "text",
    "compare_type": "beginsWith",
    "expected": [
        "a"
    ]
}'

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ condition	filter_view_condition	创建的筛选条件
└ condition_id	string	设置筛选条件的列
└ filter_type	string	筛选类型。枚举值如下所示。了解更多，参考筛选条件指南。 - multiValue ：多值筛选 - number：数字筛选 - text：文本筛选 - color：颜色筛选
└ compare_type	string	比较类型。了解更多，参考筛选条件指南。
└ expected	string\[\]	筛选参数。了解更多，参考筛选条件指南。

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "condition": {
            "condition_id": "E",
            "filter_type": "number",
            "compare_type": "less",
            "expected": [
                "6"
            ]
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1310211	Wrong Sheet Id	工作表 ID 错误。检查工作表的 ID 是否正确。获取方式见获取工作表
400	1310237	Wrong Filter View Id	筛选视图 ID 错误。获取方式参考查询筛选视图
400	1310236	Wrong Filter Value	筛选条件错误。请检查筛选条件
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	1310223	Col Id Not Found	列 ID 没有找到。请检查 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	1310232	Wrong Style	样式错误，包括颜色、字体等。请修改
400	1310249	Spreadsheet Deleted	表格已被删除。请恢复表格后重试