Get the list of filter views

Call this API to retrieve the list of all filter views on a specified worksheet. The response returns the ID, name, range, and filter conditions of each filter view. Use this API to enumerate existing views before managing or switching filter views, or to batch read filter view configurations for further processing in your program.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews`
HTTP Method	GET
Supported app type	appType-Internal app
Required permissions	permission-Document.Workbook.Read-Spreadsheet read permission

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential used to call this API. Call the Get the access token of an internal app API to obtain it.

Path parameters

Name	Type	Required	Description
workbookId	String	Yes	The Spreadsheet file ID. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the `workbookId` of the Spreadsheet. Obtain it by calling the Get node or Create a Knowledge Base document API.
sheetId	String	Yes	The Worksheet ID or name. Call the Get all worksheets API to obtain the value of the id or name parameter. Note If the Worksheet has no filter views, the API returns an empty array.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. - Call the Obtain user information by silent login code API to obtain the unionId. - Call the Query user details API to obtain the unionId. If the operator has no permission, the API returns the error `The operator has no permission`.

Request example

HTTP

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

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using Token</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 contains the code and message attributes to help locate the issue
            }

        } 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 contains the code and message attributes to help locate the issue
            }

        }        
    }
}

Python

# -*- 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:
        """
        Initialize the account Client using Token
        @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 contains the code and message attributes to help locate the issue
                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 contains the code and message attributes to help locate the issue
                pass

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

PHP

<?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 {

    /**
     * Initialize the account Client using Token
     * @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 contains the code and message attributes to help locate the issue
            }
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
Sample::main(array_slice($argv, 1));

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:
// 
// Initialize the account Client using Token
// 
// @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 contains the code and message attributes to help locate the issue
    }

  }
  return _err
}

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

Node.js

'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 {

  /**
   * Initialize the account Client using Token
   * @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 contains the code and message attributes to help locate the issue
      }

    }    
  }

}

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

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>Initialize the account Client using Token</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 contains the code and message attributes to help locate the issue
                }
            }
            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 contains the code and message attributes to help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
filterViews	Array	The list of filter views. Returns an empty array if no filter views exist.
id	String	The unique identifier of the filter view.
name	String	The name of the filter view.
range	String	The range of the filter view in A1 notation.
criteria	`Map<String, Object>`	The filter conditions for each column. The key is the column offset (relative to the primary field of the range, starting from 0), and the value is the filter condition object. Returns an empty object `{}` when no filter conditions exist.
	Object	Filter condition.
filterType	String	The filter type. Valid values: `values` (filter by value), `condition` (filter by condition), `color` (filter by color).
visibleValues	Array of String	Visible values.
conditions	Array	The list of filter conditions when filtering by condition. Effective when `filterType` is `condition`. Each condition object contains the `operator` and `value` fields.
operator	String	The condition operator. Valid values: - equal - not-equal - contains - not-contains - starts-with - not-starts-with - ends-with - not-ends-with - greater - greater-equal - less - less-equal
value	String	Condition value.
conditionOperator	String	The logical relationship between multiple conditions. Valid values: `and`, `or`. Default value: `and`. Effective when `filterType` is `condition` and multiple conditions are specified.
backgroundColor	String	The color value (hexadecimal, such as `#FF0000`) when filtering by background color. Effective when `filterType` is `color`. Mutually exclusive with `fontColor`.
fontColor	String	The color value (hexadecimal, such as `#FF0000`) when filtering by font color. Effective when `filterType` is `color`. Mutually exclusive with `backgroundColor`.

Response body example

HTTP/1.1 200 OK
Content-Type:application/json

{
  "filterViews" : [ {
    "id" : "fv-xxxxx",
    "name" : "Sales data filter",
    "range" : "A1:E20",
    "criteria" : {
      "key" : {
        "filterType" : "values",
        "visibleValues" : [ "123" ],
        "conditions" : [ {
          "operator" : "equal",
          "value" : "123"
        } ],
        "conditionOperator" : "or",
        "backgroundColor" : "#FF0000",
        "fontColor" : "#00FFFF"
      }
    }
  } ]
}

Error codes

If an error occurs when calling this API, look up the solution in the global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	The request parameters are invalid. Check the error message.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	The workbookId is invalid.
400	invalidRequest.resource.notWorkbook	%s	Unsupported document type. Check the workbookId.
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	The document is still initializing. Try again later.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission for this action.
403	forbidden.acrossOrg	%s	The request is invalid. Check whether the document being accessed belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The requested action is invalid. Check the error message.
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.	The Spreadsheet content is too large. Try reducing the Spreadsheet content.
404	invalidRequest.resource.notFound	%s	The request failed because the resource being accessed cannot be found.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	The service is busy. Try again later.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	An internal service error occurred. Try again later.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

Request

Basic information

Request headers

Path parameters

Query parameters

Request example

Response

Response body

Response body example

Error codes

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes

Request

Basic information

Request headers

Path parameters

Query parameters

Request example

Response

Response body

Response body example

Error codes