Clear filter view criteria - DingTalk Help Center

Call this API to clear the filter criteria of a specific column in a filter view, so that the column no longer participates in filter calculations. This applies when you want to remove the filter rules of one column in a personal filter view while keeping the filter state of other columns.

API call description

The clear operation only affects the current filter view and does not affect global filters or other filter views.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId}/clearColumnFilterCriteria`
HTTP Method	POST
Supported app type	appType-Internal app
Required permissions	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request header

Name	Type	Required	Description
x-acs-dingtalk-access-token	String	Yes	The access credential for calling this API. Obtain it by calling the Get the access token of an internal app API.

Path parameters

Name	Type	Required	Description
workbookId	String	Yes	The spreadsheet file ID. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the spreadsheet `workbookId`. Obtain it by calling the Get node and Create Knowledge Base document APIs.
sheetId	String	Yes	The worksheet ID or name. Obtain the id or name parameter value by calling the Get all worksheets API.
filterViewId	String	Yes	The ID of the filter view.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. - Obtain the unionid parameter value by calling the Get user information by silent login code API. - Obtain the unionid parameter value by calling the Query user details API. If the operator does not have permission, the API returns the error `The operator has no permission`.

Request body

Name	Type	Required	Description
column	Long	Yes	The column offset relative to the first column of the filter view range, starting from 0. For example, if the filter view range is `B1:E10`, then `column=0` represents column B, and `column=1` represents column C.

Request example

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filterViews/fv-xxxxx/clearColumnFilterCriteria?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json

{
  "column" : 0
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using a 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.ClearFilterViewCriteriaHeaders clearFilterViewCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaHeaders();
        clearFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaRequest clearFilterViewCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaRequest()
                .setOperatorId("ppgAxxx")
                .setColumn(0L);
        try {
            client.clearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, 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 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, which 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 a 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()
        clear_filter_view_criteria_headers = dingtalkdoc__1__0_models.ClearFilterViewCriteriaHeaders()
        clear_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_filter_view_criteria_request = dingtalkdoc__1__0_models.ClearFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0
        )
        try:
            client.clear_filter_view_criteria_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clear_filter_view_criteria_request, clear_filter_view_criteria_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 help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        clear_filter_view_criteria_headers = dingtalkdoc__1__0_models.ClearFilterViewCriteriaHeaders()
        clear_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_filter_view_criteria_request = dingtalkdoc__1__0_models.ClearFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0
        )
        try:
            await client.clear_filter_view_criteria_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clear_filter_view_criteria_request, clear_filter_view_criteria_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 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\ClearFilterViewCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearFilterViewCriteriaRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using a 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();
        $clearFilterViewCriteriaHeaders = new ClearFilterViewCriteriaHeaders([]);
        $clearFilterViewCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $clearFilterViewCriteriaRequest = new ClearFilterViewCriteriaRequest([
            "operatorId" => "ppgAxxx",
            "column" => 0
        ]);
        try {
            $client->clearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $clearFilterViewCriteriaRequest, $clearFilterViewCriteriaHeaders, 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 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 a 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
  }

  clearFilterViewCriteriaHeaders := &dingtalkdoc_1_0.ClearFilterViewCriteriaHeaders{}
  clearFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  clearFilterViewCriteriaRequest := &dingtalkdoc_1_0.ClearFilterViewCriteriaRequest{
    OperatorId: tea.String("ppgAxxx"),
    Column: tea.Int64(0),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ClearFilterViewCriteriaWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, &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 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 a 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 clearFilterViewCriteriaHeaders = new dingtalkdoc_1_0.ClearFilterViewCriteriaHeaders({ });
    clearFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let clearFilterViewCriteriaRequest = new dingtalkdoc_1_0.ClearFilterViewCriteriaRequest({
      operatorId: 'ppgAxxx',
      column: 0,
    });
    try {
      await client.clearFilterViewCriteriaWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which 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 a 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.ClearFilterViewCriteriaHeaders clearFilterViewCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaHeaders();
            clearFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaRequest clearFilterViewCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaRequest
            {
                OperatorId = "ppgAxxx",
                Column = 0,
            };
            try
            {
                client.ClearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, 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 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, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	Id of the request

Response body example

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

{
  "id" : "fv-xxxxx"
}

Error codes

If an error occurs when you call this API, find the solution in the Global error codes document based on the error message.

HttpCode	Error code	Error message	Description
400	invalidRequest.inputArgs.invalid	%s	Invalid request parameter. See the error message for details.
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 to perform this action.
403	forbidden.acrossOrg	%s	Invalid request. Check whether the document you want to access belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The requested action is invalid. See the error message for details.
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 to reduce the content.
404	invalidRequest.resource.notFound	%s	Request failed. The requested 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.

​API call description

​Request

​Basic information

​Request header

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes