获取筛选

GET

/open-apis/sheets/v3/spreadsheets/{spreadsheet_token}/sheets/{sheet_id}/filter

自建应用商店应用

获取子表的详细筛选信息

错误码

HTTP状态码	错误码	描述	排查建议
500	1315201	Server Error	服务内部错误，详询客服
500	1315203	Server Error	服务内部错误，详询客服
400	1310213	Permission Fail	没有文档相应权限
400	1310215	Sheet Id Not Found	检查 sheet_id
400	1310229	Wrong URL Param	检查 url 参数
400	1310226	Excess Limit	超出限制，参考响应体中的错误提示
400	1310217	Too Many Request	检查请求是否发送过于频繁
400	1310235	Retry Later	稍后重试
400	1310242	In Mix state	Retey Later
400	1310249	Spreadsheet Deleted	恢复表格后重试

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/sheets/v3/spreadsheets//sheets//filter' \
--header 'Authorization;'

响应示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "sheet_filter_info": {
            "range": "xxxxxx!A1:H14",
            "filtered_out_rows": [
                4
            ],
            "filter_infos": [
                {
                    "col": "E",
                    "conditions": [
                        {
                            "filter_type": "number",
                            "compare_type": "less",
                            "expected": [
                                "6"
                            ]
                        }
                    ]
                }
            ]
        }
    }
}

请求参数

Path 参数

spreadsheet_token

string

必需

表格 token 示例值："shtcnmBA*****yGehy8"

sheet_id

string

必需

子表 id 示例值："0b**12"

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

sheet_filter_info

object

筛选信息

必需

修改于 2023-01-18 06:06:02

筛选指南

创建筛选

获取筛选

错误码#

请求参数

返回响应

错误码