Membuat filter

Panggil API ini untuk membuat filter global pada Lembar Kerja tertentu dari sebuah DingTalk Spreadsheet dan menentukan rentang filter. API ini cocok untuk skenario yang memerlukan pemfilteran data spreadsheet pada tingkat rekam, seperti hanya menampilkan data untuk wilayah atau status tertentu dalam laporan penjualan.

Deskripsi panggilan API

Setelah panggilan berhasil, Anda dapat memanggil API untuk mengatur kriteria filter guna mengonfigurasi aturan filter pada setiap kolom. Rekam yang tidak memenuhi kriteria akan otomatis disembunyikan.
Setiap Lembar Kerja hanya dapat memiliki satu filter global. Jika filter sudah ada, akan dikembalikan sebuah error.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/createFilter`
Metode HTTP	POST
Jenis aplikasi yang didukung	appType-Internal app
Izin	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 dari aplikasi internal untuk memperolehnya.

Parameter jalur

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

Parameter kueri

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

Isi permintaan

Nama	Tipe	Wajib	Deskripsi
range	String	Ya	Rentang filter, dalam notasi A1. Misalnya, `A1:D10` menunjukkan area dari A1 hingga D10. Rekam pertama dari rentang filter diperlakukan sebagai rekam judul dan tidak disertakan dalam perhitungan filter.
criteria	`Map<String, Object>`	Tidak	Opsional. Mengatur kriteria filter untuk setiap kolom saat membuat filter. Key adalah offset kolom (string yang dimulai dari 0, relatif terhadap bidang utama dari rentang filter), dan value adalah object kriteria filter (FilterCriteria) untuk kolom tersebut. Jika tidak diberikan, akan dibuat filter kosong.
	Object	Tidak	Kriteria 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 kondisi diperbolehkan. Wajib hanya jika `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 kondisi.
conditionOperator	String	Tidak	Hubungan antara beberapa kondisi: `"and"` (default) atau `"or"`. Wajib hanya jika `filterType` adalah `condition`.
backgroundColor	String	Tidak	Filter berdasarkan warna latar belakang. Nilai warna heksadesimal, seperti `"#FF0000"`. Wajib hanya jika `filterType` adalah `color`.
fontColor	String	Tidak	Filter berdasarkan warna font. Nilai warna heksadesimal, seperti `"#0000FF"`. Wajib hanya jika `filterType` adalah `color`.

Contoh permintaan

HTTP

POST /v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/createFilter HTTP/1.1
Host:api.dingtalk.io
Content-Type:application/json

{
  "range": "A1:D10",
  "criteria" : {
    "0" : {
      "filterType": "values",
      "visibleValues": ["Budi", "Siti"]
    }
  }
}

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.CreateFilterHeaders createFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.CreateFilterHeaders();
        createFilterHeaders.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.CreateFilterRequest createFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.CreateFilterRequest()
                .setCriteria(criteria);
        try {
            client.createFilterWithOptions("", "", createFilterRequest, createFilterHeaders, 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 Anda 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 atribut code dan message yang membantu Anda 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 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_headers = dingtalkdoc__1__0_models.CreateFilterHeaders()
        create_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
        }
        create_filter_request = dingtalkdoc__1__0_models.CreateFilterRequest(
            criteria=criteria
        )
        try:
            client.create_filter_with_options('', '', create_filter_request, create_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 Anda menemukan issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_filter_headers = dingtalkdoc__1__0_models.CreateFilterHeaders()
        create_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
        }
        create_filter_request = dingtalkdoc__1__0_models.CreateFilterRequest(
            criteria=criteria
        )
        try:
            await client.create_filter_with_options_async('', '', create_filter_request, create_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 Anda 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\CreateFilterHeaders;
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\CreateFilterRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $createFilterHeaders = new CreateFilterHeaders([]);
        $createFilterHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $criteriaValueKeyConditions0 = new conditions([]);
        $criteriaValueKey = new CriteriaValue([
            "conditions" => [
                $criteriaValueKeyConditions0
            ]
        ]);
        $criteria = [
            "criteriaValueKey" => $criteriaValueKey
        ];
        $createFilterRequest = new CreateFilterRequest([
            "criteria" => $criteria
        ]);
        try {
            $client->createFilterWithOptions("", "", $createFilterRequest, $createFilterHeaders, 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 Anda 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 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
  }

  createFilterHeaders := &dingtalkdoc_1_0.CreateFilterHeaders{}
  createFilterHeaders.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,
  }
  createFilterRequest := &dingtalkdoc_1_0.CreateFilterRequest{
    Criteria: criteria,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.CreateFilterWithOptions(tea.String(""), tea.String(""), createFilterRequest, createFilterHeaders, &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 Anda 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 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 createFilterHeaders = new dingtalkdoc_1_0.CreateFilterHeaders({ });
    createFilterHeaders.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 createFilterRequest = new dingtalkdoc_1_0.CreateFilterRequest({
      criteria: criteria,
    });
    try {
      await client.createFilterWithOptions('', '', createFilterRequest, createFilterHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err berisi atribut code dan message yang membantu Anda 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 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.CreateFilterHeaders createFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFilterHeaders();
            createFilterHeaders.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.CreateFilterRequest createFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CreateFilterRequest
            {
                Criteria = criteria,
            };
            try
            {
                client.CreateFilterWithOptions("", "", createFilterRequest, createFilterHeaders, 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 Anda 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 atribut code dan message yang membantu Anda menemukan issue
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
id	String	Id dari permintaan

Contoh isi respons

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

{
  "id" : "filter-xxxxx"
}

Kode error

Jika suatu error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.

HttpCode	Kode error	Pesan error	Deskripsi
400	invalidRequest.inputArgs.invalid	%s	Parameter permintaan tidak valid. Lihat 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. Lihat 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. Sumber daya 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 layanan. 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 jalur

Parameter kueri

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Deskripsi panggilan API

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter jalur

​Parameter kueri

​Isi permintaan

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Deskripsi panggilan API

Permintaan

Informasi dasar

Header permintaan

Parameter jalur

Parameter kueri

Isi permintaan

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error