Get filter - DingTalk Help Center

Call this API to query the global filter currently in effect on a specified worksheet. The response returns the filter ID, the filter range, and the filter conditions set for each column. This is useful for confirming the current filter state before modifying filter conditions, or for reading the filter configuration programmatically for further processing.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/getFilter`
HTTP Method	GET
Supported app types	appType-企业内部应用
Required permissions	permission-Document.Workbook.Read-钉钉表格读权限

Request headers

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling 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 ID of the spreadsheet file. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the `workbookId` of the spreadsheet. Call the Get node or Create Knowledge Base document API to obtain it.
sheetId	String	Yes	The ID or name of the worksheet. Call the Get all worksheets API to obtain the `id` or `name` parameter value. Note If no filter exists on the worksheet, the API returns a 404 error.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. - Call the Get user information by silent login code API to obtain the `unionid` parameter value. - Call the Query user details API to obtain the `unionid` parameter value. 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/filter/getFilter?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 with the 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.GetFilterHeaders getFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetFilterHeaders();
        getFilterHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetFilterRequest getFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.GetFilterRequest()
                .setOperatorId("ppgAxxx");
        try {
            client.getFilterWithOptions("e54Lq3xxx", "Sheet1", getFilterRequest, getFilterHeaders, 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, which can help developers 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, which can help developers 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 with the 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_headers = dingtalkdoc__1__0_models.GetFilterHeaders()
        get_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_request = dingtalkdoc__1__0_models.GetFilterRequest(
            operator_id='ppgAxxx'
        )
        try:
            client.get_filter_with_options('e54Lq3xxx', 'Sheet1', get_filter_request, get_filter_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, which can help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_filter_headers = dingtalkdoc__1__0_models.GetFilterHeaders()
        get_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_request = dingtalkdoc__1__0_models.GetFilterRequest(
            operator_id='ppgAxxx'
        )
        try:
            await client.get_filter_with_options_async('e54Lq3xxx', 'Sheet1', get_filter_request, get_filter_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, which can help developers 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\GetFilterHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetFilterRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with the 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();
        $getFilterHeaders = new GetFilterHeaders([]);
        $getFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getFilterRequest = new GetFilterRequest([
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getFilterWithOptions("e54Lq3xxx", "Sheet1", $getFilterRequest, $getFilterHeaders, 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, which can help developers 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 with the 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
  }

  getFilterHeaders := &dingtalkdoc_1_0.GetFilterHeaders{}
  getFilterHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getFilterRequest := &dingtalkdoc_1_0.GetFilterRequest{
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getFilterRequest, getFilterHeaders, &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, which can help developers 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 with the 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 getFilterHeaders = new dingtalkdoc_1_0.GetFilterHeaders({ });
    getFilterHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getFilterRequest = new dingtalkdoc_1_0.GetFilterRequest({
      operatorId: 'ppgAxxx',
    });
    try {
      await client.getFilterWithOptions('e54Lq3xxx', 'Sheet1', getFilterRequest, getFilterHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message Attributes, which can help developers 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 with the 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.GetFilterHeaders getFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterHeaders();
            getFilterHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterRequest getFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterRequest
            {
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetFilterWithOptions("e54Lq3xxx", "Sheet1", getFilterRequest, getFilterHeaders, 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, which can help developers 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, which can help developers locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	The unique identifier of the filter.
range	String	The filter range in A1 notation.
criteria	`Map<String, Object>`	A mapping of filter conditions for all columns. The key is the column offset (relative to the first column of the filter range, starting from 0), and the value is the filter condition object for that column. If no filter condition is set, an empty object `{}` is returned.
	Object	The filter condition of the current column.
filterType	String	The filter type. Valid values: - values: filter by value. - color: filter by color. - condition: filter by condition.
visibleValues	Array of String	The visible values.
conditions	Array	The list of conditions when filtering by condition. Returned only when `filterType` is `condition`.
operator	String	The condition operator. Valid values: - equal: equal to. - not-equal: not equal to. - contains: contains. - not-contains: does not contain. - starts-with: starts with. - not-starts-with: does not start with. - ends-with: ends with. - not-ends-with: does not end with. - greater: greater than. - greater-equal: greater than or equal to. - less: less than. - less-equal: less than or equal to.
value	String	The condition value.
conditionOperator	String	The logical relationship between multiple conditions (`and` or `or`). Returned only when `filterType` is `condition`.
backgroundColor	String	The visible color when filtering by background color, in hexadecimal format. Returned only when `filterType` is `color` and filtering by background color.
fontColor	String	The visible color when filtering by font color, in hexadecimal format. Returned only when `filterType` is `color` and filtering by font color.

Response body example

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

{
    "id": "filter-xxxxx",
    "range": "A1:D10",
    "criteria": {
        "key": {
            "filterType": "values",
            "visibleValues": [
                "123"
            ],
        }
    }
}

Error codes

If an error occurs when calling this API, look up the error message in the Global error codes documentation to find a solution.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	Invalid request parameter. Review 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 being initialized. Try again later.
403	forbidden.accessDenied	The operator has no permission.	The current user does not have permission to perform this action.
403	forbidden.acrossOrg	%s	Invalid request. Check whether the target document belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	Invalid request action. Review 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 content.
404	invalidRequest.resource.notFound	%s	Request failed. The target resource 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 server error occurred. Try again later.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request example

​Response

​Response body

​Response body example

​Error codes