Set filter view conditions

Call this API to set or update the filter criteria for a column in a specified filter view. This is useful when you need to precisely control the visible data range of a single column in a personal filter view, such as showing only the projects you own in a personal work view, or filtering out high-priority tasks by a specific color label.

API call description

Filter view conditions only affect the current view and do not change the data that other users see.

Request

Basic information

Field	Value
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId}/setColumnFilterCriteria`
HTTP Method	POST
Supported app types	appType-Internal app
Required permissions	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 `workbookId` of the spreadsheet. Obtain it by calling the Get node and Create 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.
filterViewId	String	Yes	The filter view ID.

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 has no permission, the API returns `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`, `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 values - color: filter by color - condition: filter by condition
visibleValues	Array of String	No	The visible values.
backgroundColor	String	No	The visible background 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 font 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 allowed. Required when `filterType` is `condition`.
operator	String	No	The condition operator. Valid values: - equal: equals - not-equal: does not equal - 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 logical relationship between multiple conditions. Valid values: * and: AND (default) * or: OR. Takes effect when `conditions` contains 2 conditions.

Request example

HTTP

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

{
  "column" : 0,
  "filterCriteria" : {
    "filterType" : "values",
    "visibleValues" : [ "123" ],
  }
}

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.SetFilterViewCriteriaHeaders setFilterViewCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaHeaders();
        setFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteriaConditions()
                .setOperator("less")
                .setValue("20");
        com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria filterCriteria = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria()
                .setFilterType("values")
                .setVisibleValues(java.util.Arrays.asList(
                    "123"
                ))
                .setBackgroundColor("#FF0000")
                .setFontColor("#FF0000")
                .setConditions(java.util.Arrays.asList(
                    filterCriteriaConditions0
                ))
                .setConditionOperator("or");
        com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest setFilterViewCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest()
                .setOperatorId("ppgAxxx")
                .setColumn(0L)
                .setFilterCriteria(filterCriteria);
        try {
            client.setFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, 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, 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 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()
        set_filter_view_criteria_headers = dingtalkdoc__1__0_models.SetFilterViewCriteriaHeaders()
        set_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteriaConditions(
            operator='less',
            value='20'
        )
        filter_criteria = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteria(
            filter_type='values',
            visible_values=[
                '123'
            ],
            background_color='#FF0000',
            font_color='#FF0000',
            conditions=[
                filter_criteria_conditions_0
            ],
            condition_operator='or'
        )
        set_filter_view_criteria_request = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0,
            filter_criteria=filter_criteria
        )
        try:
            client.set_filter_view_criteria_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', set_filter_view_criteria_request, set_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 code and message attributes, which help locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        set_filter_view_criteria_headers = dingtalkdoc__1__0_models.SetFilterViewCriteriaHeaders()
        set_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteriaConditions(
            operator='less',
            value='20'
        )
        filter_criteria = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteria(
            filter_type='values',
            visible_values=[
                '123'
            ],
            background_color='#FF0000',
            font_color='#FF0000',
            conditions=[
                filter_criteria_conditions_0
            ],
            condition_operator='or'
        )
        set_filter_view_criteria_request = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0,
            filter_criteria=filter_criteria
        )
        try:
            await client.set_filter_view_criteria_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', set_filter_view_criteria_request, set_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 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\SetFilterViewCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest\filterCriteria\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest\filterCriteria;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest;
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();
        $setFilterViewCriteriaHeaders = new SetFilterViewCriteriaHeaders([]);
        $setFilterViewCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $filterCriteriaConditions0 = new conditions([
            "operator" => "less",
            "value" => "20"
        ]);
        $filterCriteria = new filterCriteria([
            "filterType" => "values",
            "visibleValues" => [
                "123"
            ],
            "backgroundColor" => "#FF0000",
            "fontColor" => "#FF0000",
            "conditions" => [
                $filterCriteriaConditions0
            ],
            "conditionOperator" => "or"
        ]);
        $setFilterViewCriteriaRequest = new SetFilterViewCriteriaRequest([
            "operatorId" => "ppgAxxx",
            "column" => 0,
            "filterCriteria" => $filterCriteria
        ]);
        try {
            $client->setFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $setFilterViewCriteriaRequest, $setFilterViewCriteriaHeaders, 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, 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
  }

  setFilterViewCriteriaHeaders := &dingtalkdoc_1_0.SetFilterViewCriteriaHeaders{}
  setFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  filterCriteriaConditions0 := &dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions{
    Operator: tea.String("less"),
    Value: tea.String("20"),
  }
  filterCriteria := &dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteria{
    FilterType: tea.String("values"),
    VisibleValues: []*string{tea.String("123")},
    BackgroundColor: tea.String("#FF0000"),
    FontColor: tea.String("#FF0000"),
    Conditions: []*dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions{filterCriteriaConditions0},
    ConditionOperator: tea.String("or"),
  }
  setFilterViewCriteriaRequest := &dingtalkdoc_1_0.SetFilterViewCriteriaRequest{
    OperatorId: tea.String("ppgAxxx"),
    Column: tea.Int64(0),
    FilterCriteria: filterCriteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.SetFilterViewCriteriaWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, &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, 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 setFilterViewCriteriaHeaders = new dingtalkdoc_1_0.SetFilterViewCriteriaHeaders({ });
    setFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let filterCriteriaConditions0 = new dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions({
      operator: 'less',
      value: '20',
    });
    let filterCriteria = new dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteria({
      filterType: 'values',
      visibleValues: [
        '123'
      ],
      backgroundColor: '#FF0000',
      fontColor: '#FF0000',
      conditions: [
        filterCriteriaConditions0
      ],
      conditionOperator: 'or',
    });
    let setFilterViewCriteriaRequest = new dingtalkdoc_1_0.SetFilterViewCriteriaRequest({
      operatorId: 'ppgAxxx',
      column: 0,
      filterCriteria: filterCriteria,
    });
    try {
      await client.setFilterViewCriteriaWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains 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.SetFilterViewCriteriaHeaders setFilterViewCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaHeaders();
            setFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions
            {
                Operator = "less",
                Value = "20",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria filterCriteria = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria
            {
                FilterType = "values",
                VisibleValues = new List<string>
                {
                    "123"
                },
                BackgroundColor = "#FF0000",
                FontColor = "#FF0000",
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions>
                {
                    filterCriteriaConditions0
                },
                ConditionOperator = "or",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest setFilterViewCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest
            {
                OperatorId = "ppgAxxx",
                Column = 0,
                FilterCriteria = filterCriteria,
            };
            try
            {
                client.SetFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, 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, 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 code and message attributes, which help locate the issue
                }
            }
        }

    }
}

Response

Response body

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

Response body example

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

{
  "id" : "fv-xxxxx"
}

Error codes

If the API call fails, 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	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 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	Invalid request. Verify that the document to be accessed belongs to the organization specified by the access token.
403	forbidden.operationIllegal	%s	Invalid request action. 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 reducing the spreadsheet content.
404	invalidRequest.resource.notFound	%s	Request failed. 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.	Internal server error. Try again later.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes

​API call description

​Request

​Basic information

​Request headers

​Path parameters

​Query parameters

​Request body

​Request example

​Response

​Response body

​Response body example

​Error codes

API call description

Request

Basic information

Request headers

Path parameters

Query parameters

Request body

Request example

Response

Response body

Response body example

Error codes