Mendapatkan daftar tampilan filter

Panggil API ini untuk mengambil daftar semua tampilan filter pada Lembar Kerja tertentu. Respons mengembalikan ID, nama, rentang, dan kondisi filter dari setiap tampilan filter. Gunakan API ini untuk melakukan enumerasi tampilan yang ada sebelum mengelola atau mengganti tampilan filter, atau untuk membaca konfigurasi tampilan filter secara massal guna diproses lebih lanjut dalam program Anda.

Permintaan

Informasi dasar

Bidang	Nilai
URL HTTP	`https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews`
Metode HTTP	GET
Jenis aplikasi yang didukung	appType-Aplikasi internal
Izin yang diperlukan	permission-Document.Workbook.Read-Izin baca Spreadsheet

Header permintaan

Nama	Tipe	Wajib	Deskripsi
x-acs-dingtalk-access-token	String	Ya	Kredensial akses yang digunakan 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 Knowledge Base API adalah `workbookId` dari Spreadsheet. Perolehlah dengan memanggil API Mendapatkan node atau 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. Catatan Jika Lembar Kerja tidak memiliki tampilan filter, API mengembalikan array kosong.

Parameter query

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

Contoh permintaan

HTTP

GET /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

Java

package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.GetFilterViewsHeaders getFilterViewsHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsHeaders();
        getFilterViewsHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest getFilterViewsRequest = new com.aliyun.dingtalkdoc_1_0.models.GetFilterViewsRequest()
                .setOperatorId("ppgAxxx");
        try {
            client.getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, 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 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 atribut code dan message untuk membantu menemukan issue
            }

        }        
    }
}

Python

# -*- coding: utf-8 -*-
# File ini dibuat otomatis, jangan diedit. Terima kasih.
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 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()
        get_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            client.get_filter_views_with_options('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_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 untuk membantu menemukan issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_filter_views_headers = dingtalkdoc__1__0_models.GetFilterViewsHeaders()
        get_filter_views_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_filter_views_request = dingtalkdoc__1__0_models.GetFilterViewsRequest(
            operator_id='ppgAxxx'
        )
        try:
            await client.get_filter_views_with_options_async('e54Lq3xxx', 'Sheet1', get_filter_views_request, get_filter_views_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 untuk membantu menemukan issue
                pass

if __name__ == '__main__':
    Sample.main(sys.argv[1:])

PHP

<?php

// File ini dibuat otomatis, jangan diedit. Terima kasih.
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\GetFilterViewsHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\GetFilterViewsRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $getFilterViewsHeaders = new GetFilterViewsHeaders([]);
        $getFilterViewsHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getFilterViewsRequest = new GetFilterViewsRequest([
            "operatorId" => "ppgAxxx"
        ]);
        try {
            $client->getFilterViewsWithOptions("e54Lq3xxx", "Sheet1", $getFilterViewsRequest, $getFilterViewsHeaders, 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 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 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
  }

  getFilterViewsHeaders := &dingtalkdoc_1_0.GetFilterViewsHeaders{}
  getFilterViewsHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getFilterViewsRequest := &dingtalkdoc_1_0.GetFilterViewsRequest{
    OperatorId: tea.String("ppgAxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetFilterViewsWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getFilterViewsRequest, getFilterViewsHeaders, &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 untuk membantu menemukan issue
    }

  }
  return _err
}

func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

Node.js

'use strict';
// File ini dibuat otomatis, jangan diedit
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 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 getFilterViewsHeaders = new dingtalkdoc_1_0.GetFilterViewsHeaders({ });
    getFilterViewsHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let getFilterViewsRequest = new dingtalkdoc_1_0.GetFilterViewsRequest({
      operatorId: 'ppgAxxx',
    });
    try {
      await client.getFilterViewsWithOptions('e54Lq3xxx', 'Sheet1', getFilterViewsRequest, getFilterViewsHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err berisi atribut 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 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.GetFilterViewsHeaders getFilterViewsHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsHeaders();
            getFilterViewsHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest getFilterViewsRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterViewsRequest
            {
                OperatorId = "ppgAxxx",
            };
            try
            {
                client.GetFilterViewsWithOptions("e54Lq3xxx", "Sheet1", getFilterViewsRequest, getFilterViewsHeaders, 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 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 atribut code dan message untuk membantu menemukan issue
                }
            }
        }

    }
}

Respons

Isi respons

Nama	Tipe	Deskripsi
filterViews	Array	Daftar tampilan filter. Mengembalikan array kosong jika tidak ada tampilan filter.
id	String	Identifier unik dari tampilan filter.
name	String	Nama tampilan filter.
range	String	Rentang tampilan filter dalam notasi A1.
criteria	`Map<String, Object>`	Kondisi filter untuk setiap kolom. Key adalah offset kolom (relatif terhadap bidang utama rentang, dimulai dari 0), dan value adalah object kondisi filter. Mengembalikan object kosong `{}` jika tidak ada kondisi filter.
	Object	Kondisi filter.
filterType	String	Tipe filter. Nilai yang valid: `values` (filter berdasarkan nilai), `condition` (filter berdasarkan kondisi), `color` (filter berdasarkan warna).
visibleValues	Array of String	Nilai yang terlihat.
conditions	Array	Daftar kondisi filter ketika memfilter berdasarkan kondisi. Berlaku ketika `filterType` bernilai `condition`. Setiap object kondisi berisi bidang `operator` dan `value`.
operator	String	Operator kondisi. Nilai yang valid: - equal - not-equal - contains - not-contains - starts-with - not-starts-with - ends-with - not-ends-with - greater - greater-equal - less - less-equal
value	String	Nilai kondisi.
conditionOperator	String	Hubungan logis antara beberapa kondisi. Nilai yang valid: `and`, `or`. Nilai default: `and`. Berlaku ketika `filterType` bernilai `condition` dan beberapa kondisi ditetapkan.
backgroundColor	String	Nilai warna (heksadesimal, seperti `#FF0000`) ketika memfilter berdasarkan warna latar belakang. Berlaku ketika `filterType` bernilai `color`. Saling eksklusif dengan `fontColor`.
fontColor	String	Nilai warna (heksadesimal, seperti `#FF0000`) ketika memfilter berdasarkan warna font. Berlaku ketika `filterType` bernilai `color`. Saling eksklusif dengan `backgroundColor`.

Contoh isi respons

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

{
  "filterViews" : [ {
    "id" : "fv-xxxxx",
    "name" : "Filter data penjualan",
    "range" : "A1:E20",
    "criteria" : {
      "key" : {
        "filterType" : "values",
        "visibleValues" : [ "123" ],
        "conditions" : [ {
          "operator" : "equal",
          "value" : "123"
        } ],
        "conditionOperator" : "or",
        "backgroundColor" : "#FF0000",
        "fontColor" : "#00FFFF"
      }
    }
  } ]
}

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 masih 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 karena resource 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 layanan. 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

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error

​Permintaan

​Informasi dasar

​Header permintaan

​Parameter path

​Parameter query

​Contoh permintaan

​Respons

​Isi respons

​Contoh isi respons

​Kode error

Permintaan

Informasi dasar

Header permintaan

Parameter path

Parameter query

Contoh permintaan

Respons

Isi respons

Contoh isi respons

Kode error