Set filter criteria - DingTalk Help Center

Call this API to set or update filter criteria for a specified column in the global filter. This is suitable for scenarios that require precise control over the visible data range of a single column.

API call description

The newly configured criteria overwrite any existing filter criteria for the column, and records that do not meet the criteria are automatically hidden.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/setColumnFilterCriteria`
HTTP Method	POST
Supported app type	appType-Internal app
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. To obtain it, call 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`. To obtain it, call the Get node or Create a Knowledge Base document API.
sheetId	String	Yes	The worksheet ID or name. To obtain the value of the id or name parameter, call the Get all worksheets API.

Query parameters

Name	Type	Required	Description
operatorId	String	Yes	The unionId of the operator. - To obtain the value of the unionid parameter, 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. 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 range, starting from 0. For example, if the filter range is `B1:E10`, `column=0` represents column B, and `column=1` represents column C.
filterCriteria	Object	Yes	The filter criteria object.
filterType	String	Yes	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.
backgroundColor	String	No	The visible color when filtering by background color, in hexadecimal format (such as `#FF0000`). When `filterType` is `color`, either `backgroundColor` or `fontColor` is required.
fontColor	String	No	The visible color when filtering by font color, in hexadecimal format (such as `#00FF00`). When `filterType` is `color`, either `backgroundColor` or `fontColor` is required.
conditions	Array	No	The list of conditions when filtering by condition. A maximum of 2 conditions are supported. This parameter is required 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 comparison value.
conditionOperator	String	No	The logical relationship between multiple conditions. Valid values: and: AND (default) or: OR. This parameter takes effect when `conditions` contains 2 conditions.

Request example

HTTP

POST /v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/setColumnFilterCriteria HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "column" : 0,
  "filterCriteria" : {
    "filterType" : "values",
    "visibleValues" : ["John", "Jane", "Mike"]
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.SetFilterCriteriaHeaders setFilterCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaHeaders();
        setFilterCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteriaConditions();
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria filterCriteria = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria()
                .setConditions(java.util.Arrays.asList(
                    filterCriteriaConditions0
                ));
        com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest setFilterCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.SetFilterCriteriaRequest()
                .setFilterCriteria(filterCriteria);
        try {
            client.setFilterCriteriaWithOptions("", "", setFilterCriteriaRequest, setFilterCriteriaHeaders, 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 properties 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 code and message properties 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 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()
        set_filter_criteria_headers = dingtalkdoc__1__0_models.SetFilterCriteriaHeaders()
        set_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteriaConditions()
        filter_criteria = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteria(
            conditions=[
                filter_criteria_conditions_0
            ]
        )
        set_filter_criteria_request = dingtalkdoc__1__0_models.SetFilterCriteriaRequest(
            filter_criteria=filter_criteria
        )
        try:
            client.set_filter_criteria_with_options('', '', set_filter_criteria_request, set_filter_criteria_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 properties to help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        set_filter_criteria_headers = dingtalkdoc__1__0_models.SetFilterCriteriaHeaders()
        set_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteriaConditions()
        filter_criteria = dingtalkdoc__1__0_models.SetFilterCriteriaRequestFilterCriteria(
            conditions=[
                filter_criteria_conditions_0
            ]
        )
        set_filter_criteria_request = dingtalkdoc__1__0_models.SetFilterCriteriaRequest(
            filter_criteria=filter_criteria
        )
        try:
            await client.set_filter_criteria_with_options_async('', '', set_filter_criteria_request, set_filter_criteria_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 properties 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\SetFilterCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest\filterCriteria\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest\filterCriteria;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterCriteriaRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $setFilterCriteriaHeaders = new SetFilterCriteriaHeaders([]);
        $setFilterCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $filterCriteriaConditions0 = new conditions([]);
        $filterCriteria = new filterCriteria([
            "conditions" => [
                $filterCriteriaConditions0
            ]
        ]);
        $setFilterCriteriaRequest = new SetFilterCriteriaRequest([
            "filterCriteria" => $filterCriteria
        ]);
        try {
            $client->setFilterCriteriaWithOptions("", "", $setFilterCriteriaRequest, $setFilterCriteriaHeaders, 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 properties 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 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
  }

  setFilterCriteriaHeaders := &dingtalkdoc_1_0.SetFilterCriteriaHeaders{}
  setFilterCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  filterCriteriaConditions0 := &dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions{}
  filterCriteria := &dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteria{
    Conditions: []*dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions{filterCriteriaConditions0},
  }
  setFilterCriteriaRequest := &dingtalkdoc_1_0.SetFilterCriteriaRequest{
    FilterCriteria: filterCriteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SetFilterCriteriaWithOptions(tea.String(""), tea.String(""), setFilterCriteriaRequest, setFilterCriteriaHeaders, &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 properties 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 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 setFilterCriteriaHeaders = new dingtalkdoc_1_0.SetFilterCriteriaHeaders({ });
    setFilterCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let filterCriteriaConditions0 = new dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteriaConditions({ });
    let filterCriteria = new dingtalkdoc_1_0.SetFilterCriteriaRequestFilterCriteria({
      conditions: [
        filterCriteriaConditions0
      ],
    });
    let setFilterCriteriaRequest = new dingtalkdoc_1_0.SetFilterCriteriaRequest({
      filterCriteria: filterCriteria,
    });
    try {
      await client.setFilterCriteriaWithOptions('', '', setFilterCriteriaRequest, setFilterCriteriaHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains code and message properties 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 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.SetFilterCriteriaHeaders setFilterCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaHeaders();
            setFilterCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria filterCriteria = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria
            {
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest.SetFilterCriteriaRequestFilterCriteria.SetFilterCriteriaRequestFilterCriteriaConditions>
                {
                    filterCriteriaConditions0
                },
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest setFilterCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterCriteriaRequest
            {
                FilterCriteria = filterCriteria,
            };
            try
            {
                client.SetFilterCriteriaWithOptions("", "", setFilterCriteriaRequest, setFilterCriteriaHeaders, 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 properties 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 code and message properties to help locate the issue
                }
            }
        }

    }
}

Response

Response body

Name	Type	Description
id	String	The unique identifier of the filter.

Response body example

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

{
  "id" : "flt-ecce06ec-46695"
}

Error codes

If the API returns an error, refer to the Global error codes documentation to find a solution 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 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 to be accessed belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	The request 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 its content.
404	invalidRequest.resource.notFound	%s	The request failed because the resource to be 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.

​API call description

​Request

​Basic information

​Request header

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes