> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 获取筛选视图列表

> 调用本接口可获取指定工作表上全部筛选视图列表,返回每个视图的 ID、名称、范围及筛选条件,适用于枚举或批量读取视图配置的场景。

调用本接口可获取指定工作表上所有筛选视图的列表，返回每个筛选视图的 ID、名称、范围及筛选条件。适用于在管理或切换筛选视图前枚举当前已有的视图，或在程序中批量读取筛选视图配置以进行后续处理的场景。

## 请求

### 基本信息

| 字段          | 值                                                                                      |
| ----------- | -------------------------------------------------------------------------------------- |
| HTTP URL    | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews` |
| HTTP Method | GET                                                                                    |
| 支持的应用类型     | appType-企业内部应用                                                                         |
| 权限要求        | permission-Document.Workbook.Read-钉钉表格读权限                                              |

### 请求头

| 名称                          | 类型     | 是否必填 | 描述                                                                                                         |
| --------------------------- | ------ | ---- | ---------------------------------------------------------------------------------------------------------- |
| x-acs-dingtalk-access-token | String | 是    | 调用该接口的访问凭证，可调用[获取企业内部应用的accessToken](/zh/open/development/obtain-the-access-token-of-an-internal-app)接口获取。 |

### 路径参数

| 名称         | 类型     | 是否必填 | 描述                                                                                                                                                                                                                                       |
| ---------- | ------ | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| workbookId | String | 是    | 表格文件 ID ，[知识库 API](/zh/open/development/knowledge-base-overview) 返回的`nodeId(dentryUuid)`即是表格`workbookId`，可通过调用[获取节点](https://open.dingtalk.com/document/orgapp/get-node)和[创建知识库文档](/zh/open/development/create-team-space-document)接口获取。 |
| sheetId    | String | 是    | 工作表ID或名称，可调用[获取所有工作表](/zh/open/development/obtain-all-worksheets)接口获取id或name参数值。  **说明**  若工作表上没有筛选视图，接口将返回空数组。                                                                                                                          |

### 查询参数

| 名称         | 类型     | 是否必填 | 描述                                                                                                                                                                                                                                                  |
| ---------- | ------ | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| operatorId | String | 是    | 操作人的unionId。   - 可通过[通过免登码获取用户信息](/zh/open/development/obtain-the-userid-of-a-user-by-using-the-log-free)接口获取unionid参数值。 - 可调用[查询用户详情](/zh/open/development/query-user-details)接口获取unionid参数值。       若操作人无权限，接口会报错`The operator has no permission`。 |

### 请求示例

HTTP

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
GET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filterViews?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>使用 Token 初始化账号Client</p>
     * @return Client
     * 
     * @throws Exception
     */
    public static com.aliyun.dingtalkdoc_1_0.Client createClient() throws Exception {
        com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
        config.protocol = "https";
        config.regionId = "central";
        return new com.aliyun.dingtalkdoc_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkdoc_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsHeaders getFilterViewsHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsHeaders();
        getFilterViewsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest getFilterViewsRequest = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest()
                .setOperatorId("ppgAxxx");
        try {
            client.getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }

        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }

        }        
    }
}
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys
import json

from typing import List

from alibabacloud_dingtalk.doc_1_0.client import Client as dingtalkdoc_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.doc_1_0 import models as dingtalkdoc__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient

class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> dingtalkdoc_1_0Client:
        """
        使用 Token 初始化账号Client
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkdoc_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            client.get_filter_views_with_options('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            await client.get_filter_views_with_options_async('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err 中含有 code 和 message 属性，可帮助开发定位问题
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])
```

PHP

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetFilterViewsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetFilterViewsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * 使用 Token 初始化账号Client
     * @return Dingtalk Client
     */
    public static function createClient(){
        $config = new Config([]);
        $config->protocol = "https";
        $config->regionId = "central";
        return new Dingtalk($config);
    }

    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        $client = self::createClient();
        $getFilterViewsHeaders = new GetFilterViewsHeaders([]);
        $getFilterViewsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getFilterViewsRequest = new GetFilterViewsRequest([
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", $getFilterViewsRequest, $getFilterViewsHeaders, new RuntimeOptions([]));
        }
        catch (Exception $err) {
            if (!($err instanceof TeaError)) {
                $err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
            }
            if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
                // err 中含有 code 和 message 属性，可帮助开发定位问题
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));
```

Go

```go theme={"theme":{"light":"github-light","dark":"github-dark"}}
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  dingtalkdoc_1_0  "github.com/alibabacloud-go/dingtalk/doc_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// 使用 Token 初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkdoc_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkdoc_1_0.Client{}
  _result, _err = dingtalkdoc_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  getFilterViewsHeaders := &dingtalkdoc_1_0.GetFilterViewsHeaders{}
  getFilterViewsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getFilterViewsRequest := &dingtalkdoc_1_0.GetFilterViewsRequest{
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetFilterViewsWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getFilterViewsRequest, getFilterViewsHeaders, &util.RuntimeOptions{})
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var err = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      err = _t
    } else {
      err.Message = tea.String(tryErr.Error())
    }
    if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
      // err 中含有 code 和 message 属性，可帮助开发定位问题
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}
```

Node.js

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkdoc_1_0 = require('@alicloud/dingtalk/doc_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * 使用 Token 初始化账号Client
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkdoc_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let getFilterViewsHeaders = new dingtalkdoc_1_0.GetFilterViewsHeaders({ });
    getFilterViewsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getFilterViewsRequest = new dingtalkdoc_1_0.GetFilterViewsRequest({
      operatorId: 'ppgAxxx',
    });
    try {
      await client.getFilterViewsWithOptions('e54Lq3xxx', 'Sheet1', getFilterViewsRequest, getFilterViewsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err 中含有 code 和 message 属性，可帮助开发定位问题
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
```

C#

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
using Newtonsoft.Json;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用 Token 初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkdoc_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkdoc_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsHeaders getFilterViewsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsHeaders();
            getFilterViewsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest getFilterViewsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest
            {
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
            catch (Exception _err)
            {
                TeaException err = new TeaException(new Dictionary<string, object>
                {
                    { "message", _err.Message }
                });
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err 中含有 code 和 message 属性，可帮助开发定位问题
                }
            }
        }

    }
}
```

## 响应

### 响应体

| 名称                | 类型                    | 描述                                                                                                                                                                                                                                                                  |
| ----------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| filterViews       | Array                 | 筛选视图列表。如果没有筛选视图，则为空数组。                                                                                                                                                                                                                                              |
| id                | String                | 筛选视图的唯一标识 ID。                                                                                                                                                                                                                                                       |
| name              | String                | 筛选视图的名称。                                                                                                                                                                                                                                                            |
| range             | String                | 筛选视图的范围，A1 表示法。                                                                                                                                                                                                                                                     |
| criteria          | `Map<String, Object>` | 各列的筛选条件。key 为列偏移量（相对于 range 首列，从 0 开始），value 为筛选条件对象。无筛选条件时为空对象 `{}`。                                                                                                                                                                                               |
|                   | Object                | 筛选条件                                                                                                                                                                                                                                                                |
| filterType        | String                | 筛选类型。可选值：`values`（按值筛选）、`condition`（按条件筛选）、`color`（按颜色筛选）。                                                                                                                                                                                                          |
| visibleValues     | Array of String       | 可见值                                                                                                                                                                                                                                                                 |
| conditions        | Array                 | 按条件筛选时，指定筛选条件列表。`filterType` 为 `condition` 时有效。每个条件对象包含 `operator`（操作符）和 `value`（条件值）字段。                                                                                                                                                                            |
| operator          | String                | 条件操作符。取值：   - **equal**：等于 - **not-equal**：不等于 - **contains**：包含 - **not-contains**：不包含 - **starts-with**：开头是 - **not-starts-with**：开头不是 - **ends-with**：结尾是 - **not-ends-with**：结尾不是 - **greater**：大于 - **greater-equal**：大于等于 - **less**：小于 - **less-equal**：小于等于 |
| value             | String                | 条件值                                                                                                                                                                                                                                                                 |
| conditionOperator | String                | 多条件之间的逻辑关系。可选值：`and`（且）、`or`（或）。默认为 `and`。`filterType` 为 `condition` 且有多个条件时有效。                                                                                                                                                                                     |
| backgroundColor   | String                | 按背景色筛选时，指定颜色值（十六进制，如 `#FF0000`）。`filterType` 为 `color` 时有效，与 `fontColor` 二选一。                                                                                                                                                                                       |
| fontColor         | String                | 按字体色筛选时，指定颜色值（十六进制，如 `#FF0000`）。`filterType` 为 `color` 时有效，与 `backgroundColor` 二选一。                                                                                                                                                                                 |

### 响应体示例

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
Content-Type:application/json

{
  "filterViews" : [ {
    "id" : "fv-xxxxx",
    "name" : "销售数据筛选",
    "range" : "A1:E20",
    "criteria" : {
      "key" : {
        "filterType" : "values",
        "visibleValues" : [ "123" ],
        "conditions" : [ {
          "operator" : "equal",
          "value" : "123"
        } ],
        "conditionOperator" : "or",
        "backgroundColor" : "#FF0000",
        "fontColor" : "#00FFFF"
      }
    }
  } ]
}
```

### 错误码

若调用该接口报错，可根据错误信息在[全局错误码](/zh/open/development/server-api-error-codes-1)文档中查找解决方案。

| HttpCode | 错误码                                        | 错误信息                                                                                                                                                | 说明                                    |
| -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
| 400      | invalidRequest.inputArgs.invalid           | %s                                                                                                                                                  | 请求参数不合法，请查看错误信息。                      |
| 400      | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal.                                                                                                                          | workbookId不合法。                        |
| 400      | invalidRequest.resource.notWorkbook        | %s                                                                                                                                                  | 不支持的文档类型，请检查workbookId。               |
| 400      | invalidRequest.document.stillInitializing  | The document is still initializing. Please try again later.                                                                                         | 文档初始化中，请稍后重试。                         |
| 403      | forbidden.accessDenied                     | The operator has no permission.                                                                                                                     | 当前用户无此操作权限。                           |
| 403      | forbidden.acrossOrg                        | %s                                                                                                                                                  | 请求不合法，请检查要访问的文档是否归属于accessToken指定的组织。 |
| 403      | forbidden.operationIllegal                 | %s                                                                                                                                                  | 请求操作不合法，请查看错误信息。                      |
| 403      | forbidden.document.sizeOverLimit           | The document size is over limit and the server is unable to complete your request. Retry is unlikely to work unless the document size is decreased. | 表格内容过大，请尝试缩减表格内容。                     |
| 404      | invalidRequest.resource.notFound           | %s                                                                                                                                                  | 请求失败，无法找到要访问的资源。                      |
| 500      | serviceBusy                                | The server is busy and unable to complete your request. Please try again later.                                                                     | 服务繁忙，请稍后重试。                           |
| 500      | internalError                              | The server encountered an internal error and was unable to complete your request. Please try again later.                                           | 服务内部错误，请稍后再试。                         |