Menetapkan kriteria filter

Panggil API ini untuk menetapkan atau memperbarui kriteria filter pada kolom tertentu di filter global. API ini cocok untuk skenario yang memerlukan kontrol presisi atas rentang data yang terlihat pada satu kolom.

Deskripsi panggilan API

Kriteria yang baru dikonfigurasi akan menimpa kriteria filter yang sudah ada pada kolom tersebut, dan record yang tidak memenuhi kriteria akan otomatis disembunyikan.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/setColumnFilterCriteria`
Metode HTTP	POST
Jenis aplikasi yang didukung	appType-Aplikasi internal
Izin	permission-Document.Workbook.Write-Izin tulis DingTalk Spreadsheet

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses untuk memanggil API ini. Untuk memperolehnya, panggil API Memperoleh access token aplikasi internal.

Parameter path

Nama	Tipe	Wajib	Deskripsi
workbookId	String	Ya	ID file spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh API Knowledge Base adalah `workbookId` spreadsheet. Untuk memperolehnya, panggil API Memperoleh node atau Membuat dokumen Knowledge Base.
sheetId	String	Ya	ID atau nama lembar kerja. Untuk memperoleh nilai parameter id atau name, panggil API Memperoleh semua lembar kerja.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId operator. - Untuk memperoleh nilai parameter unionid, panggil API Memperoleh informasi pengguna dengan kode login senyap. - Untuk memperoleh nilai parameter unionid, panggil API Melihat detail pengguna. Jika operator tidak memiliki izin, API akan mengembalikan error `The operator has no permission`.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
column	Long	Ya	Offset kolom relatif terhadap kolom pertama dari rentang filter, dimulai dari 0. Misalnya, jika rentang filter adalah `B1:E10`, `column=0` mewakili kolom B, dan `column=1` mewakili kolom C.
filterCriteria	Object	Ya	Object kriteria filter.
filterType	String	Ya	Tipe filter. Nilai yang valid: - values: filter berdasarkan nilai - color: filter berdasarkan warna - condition: filter berdasarkan kondisi
visibleValues	Array of String	Tidak	Nilai yang terlihat.
backgroundColor	String	Tidak	Warna yang terlihat saat memfilter berdasarkan warna latar belakang, dalam format heksadesimal (seperti `#FF0000`). Ketika `filterType` adalah `color`, salah satu dari `backgroundColor` atau `fontColor` wajib diisi.
fontColor	String	Tidak	Warna yang terlihat saat memfilter berdasarkan warna font, dalam format heksadesimal (seperti `#00FF00`). Ketika `filterType` adalah `color`, salah satu dari `backgroundColor` atau `fontColor` wajib diisi.
conditions	Array	Tidak	Daftar kondisi saat memfilter berdasarkan kondisi. Maksimal 2 kondisi yang didukung. Parameter ini wajib diisi ketika `filterType` adalah `condition`.
operator	String	Tidak	Operator kondisi. Nilai yang valid: - equal: sama dengan - not-equal: tidak sama dengan - contains: mengandung - not-contains: tidak mengandung - starts-with: diawali dengan - not-starts-with: tidak diawali dengan - ends-with: diakhiri dengan - not-ends-with: tidak diakhiri dengan - greater: lebih besar dari - greater-equal: lebih besar dari atau sama dengan - less: lebih kecil dari - less-equal: lebih kecil dari atau sama dengan
value	String	Tidak	Nilai pembanding.
conditionOperator	String	Tidak	Hubungan logis antara beberapa kondisi. Nilai yang valid: and: DAN (default) or: ATAU. Parameter ini berlaku ketika `conditions` berisi 2 kondisi.

Contoh permintaan

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" : ["Budi", "Siti", "Andi"]
  }
}

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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan 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 berisi properti code dan message untuk membantu menemukan issue
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
id	String	Identifier unik dari filter.

Contoh isi respons

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

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

Kode error

Jika API mengembalikan error, lihat dokumentasi Kode error global untuk menemukan solusi berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
400	invalidRequest.inputArgs.invalid	%s	Parameter permintaan tidak valid. Periksa pesan error.
400	invalidRequest.inputArgs.workbookIdIllegal	The workbookId is illegal.	workbookId tidak valid.
400	invalidRequest.resource.notWorkbook	%s	Tipe dokumen tidak didukung. Periksa workbookId.
400	invalidRequest.document.stillInitializing	The document is still initializing. Please try again later.	Dokumen sedang diinisialisasi. Coba lagi nanti.
403	forbidden.accessDenied	The operator has no permission.	Pengguna saat ini tidak memiliki izin untuk tindakan ini.
403	forbidden.acrossOrg	%s	Permintaan tidak valid. Periksa apakah dokumen yang akan diakses milik organisasi yang ditentukan oleh access token.
403	forbidden.operationIllegal	%s	Tindakan permintaan tidak valid. Periksa pesan error.
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.	Konten spreadsheet terlalu besar. Coba kurangi kontennya.
404	invalidRequest.resource.notFound	%s	Permintaan gagal karena resource yang akan diakses tidak dapat ditemukan.
500	serviceBusy	The server is busy and unable to complete your request. Please try again later.	Layanan sedang sibuk. Coba lagi nanti.
500	internalError	The server encountered an internal error and was unable to complete your request. Please try again later.	Terjadi error internal server. Coba lagi nanti.

Panduan pemanggilan API

Autentikasi & otorisasi

Kontak

Kalender

Konferensi

AI Table

Dokumen & file

IM

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Deskripsi panggilan API

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter path

​Parameter query

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error