Perbarui filter

Panggil API ini untuk memperbarui kondisi filter beberapa kolom sekaligus dalam filter global. API ini cocok untuk skenario ketika Anda perlu mengatur, mengubah, atau menghapus Aturan Filter untuk beberapa kolom secara bersamaan. Misalnya, dalam laporan analisis data, Anda dapat memfilter berdasarkan pengguna, rentang jumlah, dan warna label di beberapa dimensi sekaligus.

Permintaan

Informasi dasar

Bidang	Value
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/updateFilter`
Metode HTTP	POST
Jenis aplikasi yang didukung	appType-Internal app
Izin yang diperlukan	permission-Document.Workbook.Write-DingTalk Spreadsheet write permission

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses untuk memanggil API ini. Panggil API Mendapatkan access token aplikasi internal untuk memperolehnya.

Parameter path

Nama	Tipe	Wajib	Deskripsi
workbookId	String	Ya	ID file Spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh API Knowledge Base adalah `workbookId` Spreadsheet. Anda dapat memperolehnya dengan memanggil API Mendapatkan node dan Membuat dokumen Knowledge Base.
sheetId	String	Ya	ID atau nama Lembar Kerja. Panggil API Mendapatkan semua lembar kerja untuk memperoleh nilai parameter id atau name.

Parameter query

Nama	Tipe	Wajib	Deskripsi
operatorId	String	Ya	unionId operator. - Panggil API Mendapatkan informasi pengguna menggunakan kode login senyap untuk memperoleh nilai parameter unionid. - Panggil API Mengkueri detail pengguna untuk memperoleh nilai parameter unionid. Jika operator tidak memiliki izin, API mengembalikan error `The operator has no permission`.

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
criteria	`Map<String, Object>`	Ya	Peta dari offset kolom ke kondisi filter. Key adalah offset kolom (string yang dimulai dari 0, relatif terhadap kolom pertama dari rentang filter). Value adalah object kondisi filter untuk kolom tersebut, atau `null` (yang menghapus kondisi untuk kolom tersebut).
	Object	Tidak	Kondisi filter untuk kolom saat ini.
filterType	String	Tidak	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.
conditions	Array	Tidak	Array kondisi filter. Maksimal 2 diperbolehkan. Wajib hanya ketika `filterType` adalah `condition`.
operator	String	Tidak	Operator kondisi. Nilai yang valid: - equal: Sama dengan. - not-equal: Tidak sama dengan. - contains: Berisi. - not-contains: Tidak berisi. - 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 kondisi.
conditionOperator	String	Tidak	Hubungan antara beberapa kondisi. Atur ke `"and"` (default) atau `"or"`. Wajib hanya ketika `filterType` adalah `condition`.
backgroundColor	String	Tidak	Filter berdasarkan warna latar belakang. Nilai warna heksadesimal, seperti `"#FF0000"`. Berikan hanya ketika `filterType` adalah `color`.
fontColor	String	Tidak	Filter berdasarkan warna font. Nilai warna heksadesimal, seperti `"#0000FF"`. Berikan hanya ketika `filterType` adalah `color`.

Contoh permintaan

HTTP

POST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filter/updateFilter?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "criteria" : {
    "0" : {
      "filterType" : "values",
      "visibleValues" : ["Budi", "Siti", "Andi"]
    },
    "2" : {
      "filterType" : "condition",
      "conditions" : [
        {
          "operator" : "greater",
          "value" : "100"
        }
      ]
    }
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client with 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.UpdateFilterHeaders updateFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterHeaders();
        updateFilterHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions();
        com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue()
                .setConditions(java.util.Arrays.asList(
                    criteriaValueKeyConditions0
                ));
        java.util.Map<String, com.aliyun.dingtalkdoc_1_0.models.CriteriaValue> criteria = TeaConverter.buildMap(
            new TeaPair("criteriaValueKey", criteriaValueKey)
        );
        com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest updateFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterRequest()
                .setOperatorId("ppgAxxx")
                .setCriteria(criteria);
        try {
            client.updateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, 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 atribut code dan message yang membantu menemukan masalah
            }

        } 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 atribut code dan message yang membantu menemukan masalah
            }

        }        
    }
}

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 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()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            client.update_filter_with_options('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi atribut code dan message yang membantu menemukan masalah
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_filter_headers = dingtalkdoc__1__0_models.UpdateFilterHeaders()
        update_filter_headers.x_acs_dingtalk_access_token = '<your access token>'
        criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions()
        criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
            conditions=[
                criteria_value_key_conditions_0
            ]
        )
        criteria = {
            'criteriaValueKey': criteria_value_key
        }
        update_filter_request = dingtalkdoc__1__0_models.UpdateFilterRequest(
            operator_id='ppgAxxx',
            criteria=criteria
        )
        try:
            await client.update_filter_with_options_async('e54Lq3xxx', 'Sheet1', update_filter_request, update_filter_headers, util_models.RuntimeOptions())
        except Exception as err:
            if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
                # err berisi atribut code dan message yang membantu menemukan masalah
                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\UpdateFilterHeaders;
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\UpdateFilterRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client with 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();
        $updateFilterHeaders = new UpdateFilterHeaders([]);
        $updateFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $criteriaValueKeyConditions0 = new conditions([]);
        $criteriaValueKey = new CriteriaValue([
            "conditions" => [
                $criteriaValueKeyConditions0
            ]
        ]);
        $criteria = [
            "criteriaValueKey" => $criteriaValueKey
        ];
        $updateFilterRequest = new UpdateFilterRequest([
            "operatorId" => "ppgAxxx",
            "criteria" => $criteria
        ]);
        try {
            $client->updateFilterWithOptions("e54Lq3xxx", "Sheet1", $updateFilterRequest, $updateFilterHeaders, 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 atribut code dan message yang membantu menemukan masalah
            }
        }
    }
}
$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 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
  }

  updateFilterHeaders := &dingtalkdoc_1_0.UpdateFilterHeaders{}
  updateFilterHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{}
  criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{
    Conditions: []*dingtalkdoc_1_0.CriteriaValueConditions{criteriaValueKeyConditions0},
  }
  criteria := map[string]*dingtalkdoc_1_0.CriteriaValue{
    "criteriaValueKey": criteriaValueKey,
  }
  updateFilterRequest := &dingtalkdoc_1_0.UpdateFilterRequest{
    OperatorId: tea.String("ppgAxxx"),
    Criteria: criteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), updateFilterRequest, updateFilterHeaders, &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 atribut code dan message yang membantu menemukan masalah
    }

  }
  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 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 updateFilterHeaders = new dingtalkdoc_1_0.UpdateFilterHeaders({ });
    updateFilterHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({ });
    let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({
      conditions: [
        criteriaValueKeyConditions0
      ],
    });
    let criteria = {
      criteriaValueKey: criteriaValueKey,
    };
    let updateFilterRequest = new dingtalkdoc_1_0.UpdateFilterRequest({
      operatorId: 'ppgAxxx',
      criteria: criteria,
    });
    try {
      await client.updateFilterWithOptions('e54Lq3xxx', 'Sheet1', updateFilterRequest, updateFilterHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err berisi atribut code dan message yang membantu menemukan masalah
      }

    }    
  }

}

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 with 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.UpdateFilterHeaders updateFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterHeaders();
            updateFilterHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions();
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue
            {
                Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions>
                {
                    criteriaValueKeyConditions0
                },
            };
            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.UpdateFilterRequest updateFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterRequest
            {
                OperatorId = "ppgAxxx",
                Criteria = criteria,
            };
            try
            {
                client.UpdateFilterWithOptions("e54Lq3xxx", "Sheet1", updateFilterRequest, updateFilterHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
            }
            catch (TeaException err)
            {
                if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
                {
                    // err berisi atribut code dan message yang membantu menemukan masalah
                }
            }
            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 atribut code dan message yang membantu menemukan masalah
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
id	String	Id permintaan

Contoh isi respons

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

{
  "id" : "filter-xxxxx"
}

Kode error

Jika terjadi error saat memanggil API ini, cari solusinya di dokumen Kode error global 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 diakses milik organisasi yang ditentukan oleh access token.
403	forbidden.operationIllegal	%s	Tindakan yang diminta 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 konten Spreadsheet.
404	invalidRequest.resource.notFound	%s	Permintaan gagal. Sumber daya yang 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

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter path

​Parameter query

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error