フィルタービュー条件の削除

本 API を呼び出すと、指定したフィルタービューにおける特定の列のフィルター条件を解除し、その列をフィルター計算の対象から除外できます。個人フィルタービューにおいて、他の列の絞り込み状態は維持したまま特定列のフィルタールールのみを取り消したい場合に利用します。

API 呼び出し説明

クリア操作は現在のフィルタービューにのみ影響し、グローバルフィルターや他のフィルタービューには影響しません。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId}/clearColumnFilterCriteria`
HTTP Method	POST
サポートするアプリタイプ	appType-社内アプリ
必要な権限	permission-Document.Workbook.Write-スプレッドシート書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	この API を呼び出すためのアクセス認証情報です。社内アプリの access_token を取得する API を呼び出して取得できます。

パスパラメータ

名前	タイプ	必須	説明
workbookId	String	必須	スプレッドシートファイルの ID です。ナレッジベース API から返される `nodeId(dentryUuid)` がスプレッドシートの `workbookId` に該当します。ノードの取得およびナレッジベースドキュメントの作成 API を呼び出して取得できます。
sheetId	String	必須	ワークシートの ID または名称です。全ワークシートの取得 API を呼び出して、id または name パラメータの値を取得できます。
filterViewId	String	必須	フィルタービューの ID です。

クエリパラメータ

名前	タイプ	必須	説明
operatorId	String	必須	操作者の unionId です。 - サイレントログインコードによるユーザー情報の取得 API を呼び出して unionid パラメータの値を取得できます。 - ユーザー詳細の照会 API を呼び出して unionid パラメータの値を取得できます。操作者に権限がない場合、API は `The operator has no permission` というエラーを返します。

リクエストボディ

名前	タイプ	必須	説明
column	Long	必須	列オフセットです。フィルタービュー範囲の先頭列を基準とし、0 から始まります。例えばフィルタービュー範囲が `B1:E10` の場合、`column=0` は B 列、`column=1` は C 列を表します。

リクエスト例

HTTP

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

{
  "column" : 0
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Token を使用してアカウント Client を初期化します</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.ClearFilterViewCriteriaHeaders clearFilterViewCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaHeaders();
        clearFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaRequest clearFilterViewCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterViewCriteriaRequest()
                .setOperatorId("ppgAxxx")
                .setColumn(0L);
        try {
            client.clearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }

        } 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }

        }        
    }
}

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:
        """
        Token を使用してアカウント Client を初期化します
        @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()
        clear_filter_view_criteria_headers = dingtalkdoc__1__0_models.ClearFilterViewCriteriaHeaders()
        clear_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_filter_view_criteria_request = dingtalkdoc__1__0_models.ClearFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0
        )
        try:
            client.clear_filter_view_criteria_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clear_filter_view_criteria_request, clear_filter_view_criteria_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message プロパティが含まれており、問題の特定に役立ちます
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        clear_filter_view_criteria_headers = dingtalkdoc__1__0_models.ClearFilterViewCriteriaHeaders()
        clear_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
        clear_filter_view_criteria_request = dingtalkdoc__1__0_models.ClearFilterViewCriteriaRequest(
            operator_id='ppgAxxx',
            column=0
        )
        try:
            await client.clear_filter_view_criteria_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clear_filter_view_criteria_request, clear_filter_view_criteria_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err には code と message プロパティが含まれており、問題の特定に役立ちます
                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\ClearFilterViewCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearFilterViewCriteriaRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Token を使用してアカウント Client を初期化します
     * @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();
        $clearFilterViewCriteriaHeaders = new ClearFilterViewCriteriaHeaders([]);
        $clearFilterViewCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $clearFilterViewCriteriaRequest = new ClearFilterViewCriteriaRequest([
            "operatorId" => "ppgAxxx",
            "column" => 0
        ]);
        try {
            $client->clearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $clearFilterViewCriteriaRequest, $clearFilterViewCriteriaHeaders, 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 には code と message プロパティが含まれており、問題の特定に役立ちます
            }
        }
    }
}
$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:
// 
// Token を使用してアカウント Client を初期化します
// 
// @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
  }

  clearFilterViewCriteriaHeaders := &dingtalkdoc_1_0.ClearFilterViewCriteriaHeaders{}
  clearFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  clearFilterViewCriteriaRequest := &dingtalkdoc_1_0.ClearFilterViewCriteriaRequest{
    OperatorId: tea.String("ppgAxxx"),
    Column: tea.Int64(0),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.ClearFilterViewCriteriaWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, &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 には code と message プロパティが含まれており、問題の特定に役立ちます
    }

  }
  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 {

  /**
   * Token を使用してアカウント Client を初期化します
   * @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 clearFilterViewCriteriaHeaders = new dingtalkdoc_1_0.ClearFilterViewCriteriaHeaders({ });
    clearFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let clearFilterViewCriteriaRequest = new dingtalkdoc_1_0.ClearFilterViewCriteriaRequest({
      operatorId: 'ppgAxxx',
      column: 0,
    });
    try {
      await client.clearFilterViewCriteriaWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err には code と message プロパティが含まれており、問題の特定に役立ちます
      }

    }    
  }

}

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>Token を使用してアカウント Client を初期化します</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.ClearFilterViewCriteriaHeaders clearFilterViewCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaHeaders();
            clearFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaRequest clearFilterViewCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterViewCriteriaRequest
            {
                OperatorId = "ppgAxxx",
                Column = 0,
            };
            try
            {
                client.ClearFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", clearFilterViewCriteriaRequest, clearFilterViewCriteriaHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err には code と message プロパティが含まれており、問題の特定に役立ちます
                }
            }
            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 には code と message プロパティが含まれており、問題の特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
id	String	Id of the request

レスポンスボディ例

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

{
  "id" : "fv-xxxxx"
}

エラーコード

API 呼び出し時にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決策を確認してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	invalidRequest.inputArgs.invalid	%s	リクエストパラメータが不正です。エラーメッセージを確認してください。
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId が不正です。
400	invalidRequest.resource.notWorkbook	%s	サポートされていないドキュメントタイプです。workbookId をご確認ください。
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	ドキュメントの初期化中です。後で再試行してください。
403	forbidden.accessDenied	The operator has no permission.	現在のユーザーには操作権限がありません。
403	forbidden.acrossOrg	%s	リクエストが不正です。アクセス対象のドキュメントが accessToken で指定された組織に所属しているかご確認ください。
403	forbidden.operationIllegal	%s	リクエスト操作が不正です。エラーメッセージをご確認ください。
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.	スプレッドシートのコンテンツが大きすぎます。コンテンツの縮小をお試しください。
404	invalidRequest.resource.notFound	%s	リクエストに失敗しました。アクセス対象のリソースが見つかりません。
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	サービスが混雑しています。後で再試行してください。
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	サービス内部エラーが発生しました。後で再試行してください。

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

フィルタービュー条件の削除

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード