> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # Create a filter view > Call this API to create a filter view on a target worksheet in DingTalk Spreadsheet, specifying the view name and filter range; filter criteria can then be configured per column. Call this API to create a filter view on a specified worksheet in a DingTalk Spreadsheet, and to specify the view name and filter range. After the view is created, you can further configure filter conditions for each column. ## API call description * A filter view is a personalized data filtering method independent of the global filter. It is suitable for multi-user collaboration scenarios where different users need to view different subsets of data. * Each worksheet supports up to 20 filter views. ## Request ### Basic information | Field | Value | | ------------------- | -------------------------------------------------------------------------------------- | | HTTP URL | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews` | | HTTP Method | POST | | Supported app type | appType-Internal app | | Permission 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](/open/development/obtain-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](/open/development/knowledge-base-overview) is the spreadsheet `workbookId`. You can obtain it by calling the [Get node](https://open.dingtalk.com/document/orgapp/get-node) or [Create knowledge base document](/open/development/create-team-space-document) API. | | sheetId | String | Yes | The worksheet ID or name. Call the [Get all worksheets](/open/development/obtain-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 [Get user information by silent login code](/open/development/obtain-the-userid-of-a-user-by-using-the-log-free) API to obtain the value of the unionid parameter. - Call the [Query user details](/open/development/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 | Name | Type | Required | Description | | ----------------- | --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | name | String | Yes | The name of the filter view. | | range | String | Yes | The range of the filter view, expressed in A1 notation. For example, `A1:D10` indicates the area from A1 to D10. The first row of the filter range is used as the header row and is not included in the filter calculation. | | criteria | `Map` | No | Sets filter conditions for each column when the view is created. The key is the column offset (relative to the first column of the range, starting from 0), and the value is the filter condition object. If not provided, an empty filter view is created. | | | 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 list of filter conditions when filtering by condition. Valid only when `filterType` is set to `condition`. Each condition object contains the `operator` and `value` fields. | | 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 logical relationship between multiple conditions. Valid values: `and`, `or`. The default value is `and`. Valid only when `filterType` is set to `condition` and multiple conditions are provided. | | backgroundColor | String | No | The color value (hexadecimal, for example, `#FF0000`) when filtering by background color. Valid only when `filterType` is set to `color`. Use either this parameter or `fontColor`. | | fontColor | String | No | The color value (hexadecimal, for example, `#FF0000`) when filtering by font color. Valid only when `filterType` is set to `color`. Use either this parameter or `backgroundColor`. | ### Request example HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filterViews?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" : "condition", "conditions" : [ { "operator" : "less", "value" : "20" } ], } } } ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * description : *

Initialize the account Client with a Token

* @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.CreateFilterViewHeaders createFilterViewHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateFilterViewHeaders(); createFilterViewHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions() .setOperator("less") .setValue("20"); com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue() .setFilterType("condition") .setVisibleValues(java.util.Arrays.asList( "123" )) .setConditions(java.util.Arrays.asList( criteriaValueKeyConditions0 )) .setConditionOperator("or") .setBackgroundColor("#FF0000") .setFontColor("#FF0000"); java.util.Map criteria = TeaConverter.buildMap( new TeaPair("criteriaValueKey", criteriaValueKey) ); com.aliyun.dingtalkdoc_1_0.models.CreateFilterViewRequest createFilterViewRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateFilterViewRequest() .setOperatorId("ppgAxxx") .setName("Sales data filter") .setRange("A1:E20") .setCriteria(criteria); try { client.createFilterViewWithOptions("e54Lq3xxx", "Sheet1", createFilterViewRequest, createFilterViewHeaders, 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 developers 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 developers locate the issue } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- 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() create_filter_view_headers = dingtalkdoc__1__0_models.CreateFilterViewHeaders() create_filter_view_headers.x_acs_dingtalk_access_token = '' criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions( operator='less', value='20' ) criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue( filter_type='condition', visible_values=[ '123' ], conditions=[ criteria_value_key_conditions_0 ], condition_operator='or', background_color='#FF0000', font_color='#FF0000' ) criteria = { 'criteriaValueKey': criteria_value_key } create_filter_view_request = dingtalkdoc__1__0_models.CreateFilterViewRequest( operator_id='ppgAxxx', name='Sales data filter', range='A1:E20', criteria=criteria ) try: client.create_filter_view_with_options('e54Lq3xxx', 'Sheet1', create_filter_view_request, create_filter_view_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 developers locate the issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() create_filter_view_headers = dingtalkdoc__1__0_models.CreateFilterViewHeaders() create_filter_view_headers.x_acs_dingtalk_access_token = '' criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions( operator='less', value='20' ) criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue( filter_type='condition', visible_values=[ '123' ], conditions=[ criteria_value_key_conditions_0 ], condition_operator='or', background_color='#FF0000', font_color='#FF0000' ) criteria = { 'criteriaValueKey': criteria_value_key } create_filter_view_request = dingtalkdoc__1__0_models.CreateFilterViewRequest( operator_id='ppgAxxx', name='Sales data filter', range='A1:E20', criteria=criteria ) try: await client.create_filter_view_with_options_async('e54Lq3xxx', 'Sheet1', create_filter_view_request, create_filter_view_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 developers locate the issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $createFilterViewHeaders = new CreateFilterViewHeaders([]); $createFilterViewHeaders->xAcsDingtalkAccessToken = ""; $criteriaValueKeyConditions0 = new conditions([ "operator" => "less", "value" => "20" ]); $criteriaValueKey = new CriteriaValue([ "filterType" => "condition", "visibleValues" => [ "123" ], "conditions" => [ $criteriaValueKeyConditions0 ], "conditionOperator" => "or", "backgroundColor" => "#FF0000", "fontColor" => "#FF0000" ]); $criteria = [ "criteriaValueKey" => $criteriaValueKey ]; $createFilterViewRequest = new CreateFilterViewRequest([ "operatorId" => "ppgAxxx", "name" => "Sales data filter", "range" => "A1:E20", "criteria" => $criteria ]); try { $client->createFilterViewWithOptions("e54Lq3xxx", "Sheet1", $createFilterViewRequest, $createFilterViewHeaders, 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 developers 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 ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 } createFilterViewHeaders := &dingtalkdoc_1_0.CreateFilterViewHeaders{} createFilterViewHeaders.XAcsDingtalkAccessToken = tea.String("") criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{ Operator: tea.String("less"), Value: tea.String("20"), } criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{ FilterType: tea.String("condition"), 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, } createFilterViewRequest := &dingtalkdoc_1_0.CreateFilterViewRequest{ 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.CreateFilterViewWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), createFilterViewRequest, createFilterViewHeaders, &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 developers locate the issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} '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 createFilterViewHeaders = new dingtalkdoc_1_0.CreateFilterViewHeaders({ }); createFilterViewHeaders.xAcsDingtalkAccessToken = ''; let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({ operator: 'less', value: '20', }); let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({ filterType: 'condition', visibleValues: [ '123' ], conditions: [ criteriaValueKeyConditions0 ], conditionOperator: 'or', backgroundColor: '#FF0000', fontColor: '#FF0000', }); let criteria = { criteriaValueKey: criteriaValueKey, }; let createFilterViewRequest = new dingtalkdoc_1_0.CreateFilterViewRequest({ operatorId: 'ppgAxxx', name: 'Sales data filter', range: 'A1:E20', criteria: criteria, }); try { await client.createFilterViewWithOptions('e54Lq3xxx', 'Sheet1', createFilterViewRequest, createFilterViewHeaders, 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 developers locate the issue } } } } exports.Client = Client; Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 { /// Description: /// /// Initialize the account Client with a Token /// /// /// /// Client /// /// /// Exception: /// 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.CreateFilterViewHeaders createFilterViewHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFilterViewHeaders(); createFilterViewHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions { Operator = "less", Value = "20", }; AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue { FilterType = "condition", VisibleValues = new List { "123" }, Conditions = new List { criteriaValueKeyConditions0 }, ConditionOperator = "or", BackgroundColor = "#FF0000", FontColor = "#FF0000", }; Dictionary criteria = new Dictionary { {"criteriaValueKey", criteriaValueKey}, }; AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFilterViewRequest createFilterViewRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFilterViewRequest { OperatorId = "ppgAxxx", Name = "Sales data filter", Range = "A1:E20", Criteria = criteria, }; try { client.CreateFilterViewWithOptions("e54Lq3xxx", "Sheet1", createFilterViewRequest, createFilterViewHeaders, 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 developers locate the issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "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 developers locate the issue } } } } } ``` ## Response ### Response body | Name | Type | Description | | ----- | ------ | ------------------------------------------------------- | | id | String | The unique identifier of the filter view. | | name | String | The name of the filter view. | | range | String | The range of the filter view, expressed in A1 notation. | ### Response body example ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} 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](/open/development/server-api-error-codes-1) 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 | The document type is not supported. 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 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 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 content. | | 404 | invalidRequest.resource.notFound | %s | The 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. | An internal server error occurred. Try again later. |