Skip to main content
Call this API to update the name, range, or filter conditions of a specified filter view. All fields are optional, and only the fields you pass in are updated. This API is suitable for adjusting an existing filter view—for example, renaming the view for easier identification, expanding the filter range to cover new data columns, or modifying the filter rule of a column to reflect the latest business needs.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId}
HTTP MethodPATCH
Supported app typeappType-Internal app
Required permissionspermission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Request headers

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential for calling this API. Call the Get the access token of an internal app API to obtain it.

Path parameters

NameTypeRequiredDescription
workbookIdStringYesThe 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.
sheetIdStringYesThe Worksheet ID or name. Call the Get all worksheets API to obtain the value of the id or name parameter.
filterViewIdStringYesThe ID of the filter view.

Query parameters

NameTypeRequiredDescription
operatorIdStringYesThe unionId of the operator. - Call the Obtain the user ID of a user by using a 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 error The operator has no permission.

Request body

NameTypeRequiredDescription
nameStringNoThe new name of the filter view. If not passed, the name is not updated.
rangeStringNoThe new range of the filter view, in A1 notation. If not passed, the range is not updated.
criteriaMap<String, Object>NoThe column filter conditions to update. The key is the column offset (relative to the first column of range, starting from 0), and the value is the filter condition object. Only the columns passed in are updated; the existing filter conditions of other columns are not affected. If not passed, the filter conditions are not updated.
ObjectNoThe filter condition object of the current column.
filterTypeStringNoThe filter type. Valid values: - values: Filter by value - color: Filter by color - condition: Filter by condition
visibleValuesArray of StringNoVisible values.
conditionsArrayNoThe list of filter conditions when filtering by condition. Valid when filterType is condition. Each condition object contains the operator and value fields.
operatorStringNoThe 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
valueStringNoThe condition value.
conditionOperatorStringNoThe logical relationship between multiple conditions. Valid values: and, or. Default value: and. Valid when filterType is condition and multiple conditions are specified.
backgroundColorStringNoThe color value (hexadecimal, such as #FF0000) when filtering by background color. Valid when filterType is color. Specify either this field or fontColor.
fontColorStringNoThe color value (hexadecimal, such as #FF0000) when filtering by font color. Valid when filterType is color. Specify either this field or backgroundColor.

Request example

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

{
  "name" : "Sales data filter",
  "range" : "A1:E20",
  "criteria" : {
    "key" : {
      "filterType" : "values",
      "visibleValues" : [ "123" ],
    }
  }
}
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.UpdateFilterViewHeaders updateFilterViewHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewHeaders();
        updateFilterViewHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions()
                .setOperator("or")
                .setValue("20");
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue()
                .setFilterType("values")
                .setVisibleValues(java.util.Arrays.asList(
                    "123"
                ))
                .setConditions(java.util.Arrays.asList(
                    criteriaValueKeyConditions0
                ))
                .setConditionOperator("or")
                .setBackgroundColor("#FF0000")
                .setFontColor("#FF0000");
        java.util.Map<String, com.aliyun.dingtalkdoc_1_0.models.CriteriaValue> criteria = TeaConverter.buildMap(
            new TeaPair("criteriaValueKey", criteriaValueKey)
        );
        com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewRequest updateFilterViewRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewRequest()
                .setOperatorId("ppgAxxx")
                .setName("Sales data filter")
                .setRange("A1:E20")
                .setCriteria(criteria);
        try {
            client.updateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", updateFilterViewRequest, updateFilterViewHeaders, new com.aliyun.teautil.models.RuntimeOptions());
        } catch (TeaException err) {
            if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
                // The err object contains the code and message attributes, which help you 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)) {
                // The err object contains the code and message attributes, which help you 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()
        update_filter_view_headers = dingtalkdoc__1__0_models.UpdateFilterViewHeaders()
        update_filter_view_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions(
            operator='or',
            value='20'
        )
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            filter_type='values',
            visible_values=[
                '123'
            ],
            conditions=[
                criteria_value_key_conditions_0
            ],
            condition_operator='or',
            background_color='#FF0000',
            font_color='#FF0000'
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_view_request = dingtalkdoc__1__0_models.UpdateFilterViewRequest(
            operator_id='ppgAxxx',
            name='Sales data filter',
            range='A1:E20',
            criteria=criteria
        )
        try:
            client.update_filter_view_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', update_filter_view_request, update_filter_view_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message attributes, which help you locate the issue.
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_filter_view_headers = dingtalkdoc__1__0_models.UpdateFilterViewHeaders()
        update_filter_view_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions(
            operator='or',
            value='20'
        )
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            filter_type='values',
            visible_values=[
                '123'
            ],
            conditions=[
                criteria_value_key_conditions_0
            ],
            condition_operator='or',
            background_color='#FF0000',
            font_color='#FF0000'
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_view_request = dingtalkdoc__1__0_models.UpdateFilterViewRequest(
            operator_id='ppgAxxx',
            name='Sales data filter',
            range='A1:E20',
            criteria=criteria
        )
        try:
            await client.update_filter_view_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', update_filter_view_request, update_filter_view_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # The err object contains the code and message attributes, which help you 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\UpdateFilterViewHeaders;
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\UpdateFilterViewRequest;
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();
        $updateFilterViewHeaders = new UpdateFilterViewHeaders([]);
        $updateFilterViewHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $criteriaValueKeyConditions0 = new conditions([
            "operator" => "or",
            "value" => "20"
        ]);
        $criteriaValueKey = new CriteriaValue([
            "filterType" => "values",
            "visibleValues" => [
                "123"
            ],
            "conditions" => [
                $criteriaValueKeyConditions0
            ],
            "conditionOperator" => "or",
            "backgroundColor" => "#FF0000",
            "fontColor" => "#FF0000"
        ]);
        $criteria = [
            "criteriaValueKey" => $criteriaValueKey
        ];
        $updateFilterViewRequest = new UpdateFilterViewRequest([
            "operatorId" => "ppgAxxx",
            "name" => "Sales data filter",
            "range" => "A1:E20",
            "criteria" => $criteria
        ]);
        try {
            $client->updateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $updateFilterViewRequest, $updateFilterViewHeaders, 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)) {
                // The err object contains the code and message attributes, which help you 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));
Go
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
  }

  updateFilterViewHeaders := &dingtalkdoc_1_0.UpdateFilterViewHeaders{}
  updateFilterViewHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{
    Operator: tea.String("or"),
    Value: tea.String("20"),
  }
  criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{
    FilterType: tea.String("values"),
    VisibleValues: []*string{tea.String("123")},
    Conditions: []*dingtalkdoc_1_0.CriteriaValueConditions{criteriaValueKeyConditions0},
    ConditionOperator: tea.String("or"),
    BackgroundColor: tea.String("#FF0000"),
    FontColor: tea.String("#FF0000"),
  }
  criteria := map[string]*dingtalkdoc_1_0.CriteriaValue{
    "criteriaValueKey": criteriaValueKey,
  }
  updateFilterViewRequest := &dingtalkdoc_1_0.UpdateFilterViewRequest{
    OperatorId: tea.String("ppgAxxx"),
    Name: tea.String("Sales data filter"),
    Range: tea.String("A1:E20"),
    Criteria: criteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFilterViewWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), updateFilterViewRequest, updateFilterViewHeaders, &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)) {
      // The err object contains the code and message attributes, which help you 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 updateFilterViewHeaders = new dingtalkdoc_1_0.UpdateFilterViewHeaders({ });
    updateFilterViewHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({
      operator: 'or',
      value: '20',
    });
    let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({
      filterType: 'values',
      visibleValues: [
        '123'
      ],
      conditions: [
        criteriaValueKeyConditions0
      ],
      conditionOperator: 'or',
      backgroundColor: '#FF0000',
      fontColor: '#FF0000',
    });
    let criteria = {
      criteriaValueKey: criteriaValueKey,
    };
    let updateFilterViewRequest = new dingtalkdoc_1_0.UpdateFilterViewRequest({
      operatorId: 'ppgAxxx',
      name: 'Sales data filter',
      range: 'A1:E20',
      criteria: criteria,
    });
    try {
      await client.updateFilterViewWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', updateFilterViewRequest, updateFilterViewHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // The err object contains the code and message attributes, which help you locate the issue.
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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.UpdateFilterViewHeaders updateFilterViewHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterViewHeaders();
            updateFilterViewHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions
            {
                Operator = "or",
                Value = "20",
            };
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue
            {
                FilterType = "values",
                VisibleValues = new List<string>
                {
                    "123"
                },
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions>
                {
                    criteriaValueKeyConditions0
                },
                ConditionOperator = "or",
                BackgroundColor = "#FF0000",
                FontColor = "#FF0000",
            };
            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.UpdateFilterViewRequest updateFilterViewRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterViewRequest
            {
                OperatorId = "ppgAxxx",
                Name = "Sales data filter",
                Range = "A1:E20",
                Criteria = criteria,
            };
            try
            {
                client.UpdateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", updateFilterViewRequest, updateFilterViewHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // The err object contains the code and message attributes, which help you 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))
                {
                    // The err object contains the code and message attributes, which help you locate the issue.
                }
            }
        }

    }
}

Response

Response body

NameTypeDescription
idStringThe unique identifier ID of the filter view.
nameStringThe updated name of the filter view.
rangeStringThe updated range of the filter view, in A1 notation.

Response body example

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

{
  "id" : "fv-xxxxx",
  "name" : "Sales data filter",
  "range" : "A1:E20"
}

Error codes

If an error occurs when you call this API, look up the solution in the Global error codes document based on the error message.
HttpCodeError codeError messageDescription
400invalidRequest.inputArgs.invalid%sThe request parameter is invalid. Check the error message.
400invalidRequest.inputArgs.workbookIdIllegalThe workbookId is illegal.The workbookId is invalid.
400invalidRequest.resource.notWorkbook%sUnsupported document type. Check the workbookId.
400invalidRequest.document.stillInitializingThe document is still initializing. Please try again later.The document is initializing. Try again later.
403forbidden.accessDeniedThe operator has no permission.The current user does not have permission to perform this action.
403forbidden.acrossOrg%sThe request is invalid. Check whether the document to access belongs to the organization specified by the access token.
403forbidden.operationIllegal%sThe requested action is invalid. Check the error message.
403forbidden.document.sizeOverLimitThe 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.
404invalidRequest.resource.notFound%sThe request failed. The resource to access cannot be found.
500serviceBusyThe server is busy and unable to complete your request. Please try again later.The service is busy. Try again later.
500internalErrorThe server encountered an internal error and was unable to complete your request. Please try again later.An internal service error occurred. Try again later.