Update filter - DingTalk Help Center

Call this API to batch update filter conditions for multiple columns in a global filter at once. This API is suitable for scenarios where you need to set, modify, or clear filter rules for multiple columns simultaneously. For example, in a data analysis report, you can filter by user, amount range, and label color across multiple dimensions at the same time.

Request

Basic information

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

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 Spreadsheet file ID. The `nodeId(dentryUuid)` returned by the Knowledge Base API is the Spreadsheet `workbookId`. You can obtain it by calling the Get node and Create a Knowledge Base document APIs.
sheetId	String	Yes	The Worksheet ID or name. Call the Get all worksheets API to obtain the value of the id or name parameter.

Query parameters

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

Request body

Name	Type	Required	Description
criteria	`Map<String, Object>`	Yes	A map from column offsets to filter conditions. The key is the column offset (a string starting from 0, relative to the first column of the filter range). The value is the filter condition object for that column, or `null` (which clears the condition for that column).
	Object	No	The filter condition for the current column.
filterType	String	No	The filter type. Valid values: - values: Filter by value. - color: Filter by color. - condition: Filter by condition.
visibleValues	Array of String	No	The visible values.
conditions	Array	No	The array of filter conditions. Up to 2 are allowed. Required only when `filterType` is `condition`.
operator	String	No	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	No	The condition value.
conditionOperator	String	No	The relationship between multiple conditions. Set to `"and"` (default) or `"or"`. Required only when `filterType` is `condition`.
backgroundColor	String	No	Filter by background color. A hexadecimal color value, such as `"#FF0000"`. Pass only when `filterType` is `color`.
fontColor	String	No	Filter by font color. A hexadecimal color value, such as `"#0000FF"`. Pass only when `filterType` is `color`.

Request example

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filter/updateFilter?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "criteria" : {
    "0" : {
      "filterType" : "values",
      "visibleValues" : ["John", "Jane", "Mike"]
    },
    "2" : {
      "filterType" : "condition",
      "conditions" : [
        {
          "operator" : "greater",
          "value" : "100"
        }
      ]
    }
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with 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.UpdateFilterHeaders updateFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterHeaders();
        updateFilterHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions();
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue()
                .setConditions(java.util.Arrays.asList(
                    criteriaValueKeyConditions0
                ));
        java.util.Map<String, com.aliyun.dingtalkdoc_1_0.models.CriteriaValue> criteria = TeaConverter.buildMap(
            new TeaPair("criteriaValueKey", criteriaValueKey)
        );
        com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest updateFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest()
                .setOperatorId("ppgAxxx")
                .setCriteria(criteria);
        try {
            client.updateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, 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 code and message attributes that 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 code and message attributes that 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 with 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()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            client.update_filter_with_options('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            await client.update_filter_with_options_async('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err contains code and message attributes that 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\UpdateFilterHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CriteriaValue\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\CriteriaValue;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\UpdateFilterRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $updateFilterHeaders = new UpdateFilterHeaders([]);
        $updateFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $criteriaValueKeyConditions0 = new conditions([]);
        $criteriaValueKey = new CriteriaValue([
            "conditions" => [
                $criteriaValueKeyConditions0
            ]
        ]);
        $criteria = [
            "criteriaValueKey" => $criteriaValueKey
        ];
        $updateFilterRequest = new UpdateFilterRequest([
            "operatorId" => "ppgAxxx",
            "criteria" => $criteria
        ]);
        try {
            $client->updateFilterWithOptions("e54Lq3xxx", "Sheet1", $updateFilterRequest, $updateFilterHeaders, 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 code and message attributes that 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 with 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
  }

  updateFilterHeaders := &dingtalkdoc_1_0.UpdateFilterHeaders{}
  updateFilterHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{}
  criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{
    Conditions: []*dingtalkdoc_1_0.CriteriaValueConditions{criteriaValueKeyConditions0},
  }
  criteria := map[string]*dingtalkdoc_1_0.CriteriaValue{
    "criteriaValueKey": criteriaValueKey,
  }
  updateFilterRequest := &dingtalkdoc_1_0.UpdateFilterRequest{
    OperatorId: tea.String("ppgAxxx"),
    Criteria: criteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateFilterRequest, updateFilterHeaders, &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 code and message attributes that 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 with 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 updateFilterHeaders = new dingtalkdoc_1_0.UpdateFilterHeaders({ });
    updateFilterHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({ });
    let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({
      conditions: [
        criteriaValueKeyConditions0
      ],
    });
    let criteria = {
      criteriaValueKey: criteriaValueKey,
    };
    let updateFilterRequest = new dingtalkdoc_1_0.UpdateFilterRequest({
      operatorId: 'ppgAxxx',
      criteria: criteria,
    });
    try {
      await client.updateFilterWithOptions('e54Lq3xxx', 'Sheet1', updateFilterRequest, updateFilterHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message attributes that 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 with 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.UpdateFilterHeaders updateFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterHeaders();
            updateFilterHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue
            {
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions>
                {
                    criteriaValueKeyConditions0
                },
            };
            Dictionary<string, AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue> criteria = new Dictionary<string, AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue>
            {
                {"criteriaValueKey", criteriaValueKey},
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterRequest updateFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterRequest
            {
                OperatorId = "ppgAxxx",
                Criteria = criteria,
            };
            try
            {
                client.UpdateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err contains code and message attributes that 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 code and message attributes that 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" : "filter-xxxxx"
}

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 parameter is 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 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. 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 server error occurred. Try again later.

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes