> ## Documentation Index > Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt > Use this file to discover all available pages before exploring further. # Mendapatkan filter > Panggil API ini untuk mengambil filter global yang sedang aktif pada Lembar Kerja tertentu di DingTalk Spreadsheet — menampilkan ID filter, rentang, dan kondisi per kolom untuk memverifikasi status atau membaca konfigurasi filter. Panggil API ini untuk membaca filter global yang sedang berlaku pada Lembar Kerja tertentu. Respons mengembalikan ID filter, rentang filter, dan kondisi filter yang diatur untuk setiap kolom. Ini berguna untuk memverifikasi status filter saat ini sebelum mengubah kondisi filter, atau untuk membaca konfigurasi filter secara programatik guna pemrosesan lebih lanjut. ## Permintaan ### Informasi dasar | Bidang | Nilai | | --------------------------- | ------------------------------------------------------------------------------------------- | | URL HTTP | `https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/getFilter` | | Metode HTTP | GET | | Tipe aplikasi yang didukung | appType-企业内部应用 | | Izin yang diwajibkan | permission-Document.Workbook.Read-钉钉表格读权限 | ### 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](/id/open/development/obtain-the-access-token-of-an-internal-app) untuk memperolehnya. | ### Parameter path | Nama | Tipe | Wajib | Deskripsi | | ---------- | ------ | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | workbookId | String | Ya | ID dari file Spreadsheet. `nodeId(dentryUuid)` yang dikembalikan oleh [Knowledge Base API](/id/open/development/knowledge-base-overview) adalah `workbookId` dari Spreadsheet tersebut. Panggil API [Mendapatkan node](/id/open/development/get-knowledge-base-acquisition-node) atau [Membuat dokumen Knowledge Base](/id/open/development/create-team-space-document) untuk memperolehnya. | | sheetId | String | Ya | ID atau nama Lembar Kerja. Panggil API [Mendapatkan semua Lembar Kerja](/id/open/development/obtain-all-worksheets) untuk memperoleh nilai parameter `id` atau `name`. **Catatan** Jika tidak ada filter pada Lembar Kerja, API mengembalikan error 404. | ### Parameter query | Nama | Tipe | Wajib | Deskripsi | | ---------- | ------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operatorId | String | Ya | unionId dari operator. - Panggil API [Mendapatkan informasi pengguna melalui kode Login senyap](/id/open/development/obtain-the-userid-of-a-user-by-using-the-log-free) untuk memperoleh nilai parameter `unionid`. - Panggil API [Kueri detail pengguna](/id/open/development/query-user-details) untuk memperoleh nilai parameter `unionid`. Jika operator tidak memiliki izin, API mengembalikan error `The operator has no permission`. | ### Contoh permintaan HTTP ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} GET /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filter/getFilter?operatorId=ppgAxxx HTTP/1.1 Host:api.dingtalk.io x-acs-dingtalk-access-token:f86e0bxxx Content-Type:application/json ``` Java ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} package com.aliyun.sample; import com.aliyun.tea.*; public class Sample { /** * description : *

Initialize the account Client with the token

* @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.GetFilterHeaders getFilterHeaders = new com.aliyun.dingtalkdoc_1_0.models.GetFilterHeaders(); getFilterHeaders.xAcsDingtalkAccessToken = ""; com.aliyun.dingtalkdoc_1_0.models.GetFilterRequest getFilterRequest = new com.aliyun.dingtalkdoc_1_0.models.GetFilterRequest() .setOperatorId("ppgAxxx"); try { client.getFilterWithOptions("e54Lq3xxx", "Sheet1", getFilterRequest, getFilterHeaders, 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 dapat membantu developer melacak 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 dapat membantu developer melacak issue } } } } ``` Python ```python theme={"theme":{"light":"github-light","dark":"github-dark"}} # -*- coding: utf-8 -*- # File ini dibuat otomatis, jangan mengeditnya. 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 with 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() get_filter_headers = dingtalkdoc__1__0_models.GetFilterHeaders() get_filter_headers.x_acs_dingtalk_access_token = '' get_filter_request = dingtalkdoc__1__0_models.GetFilterRequest( operator_id='ppgAxxx' ) try: client.get_filter_with_options('e54Lq3xxx', 'Sheet1', get_filter_request, get_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 dapat membantu developer melacak issue pass @staticmethod async def main_async( args: List[str], ) -> None: client = Sample.create_client() get_filter_headers = dingtalkdoc__1__0_models.GetFilterHeaders() get_filter_headers.x_acs_dingtalk_access_token = '' get_filter_request = dingtalkdoc__1__0_models.GetFilterRequest( operator_id='ppgAxxx' ) try: await client.get_filter_with_options_async('e54Lq3xxx', 'Sheet1', get_filter_request, get_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 dapat membantu developer melacak issue pass if __name__ == '__main__': Sample.main(sys.argv[1:]) ``` PHP ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} protocol = "https"; $config->regionId = "central"; return new Dingtalk($config); } /** * @param string[] $args * @return void */ public static function main($args){ $client = self::createClient(); $getFilterHeaders = new GetFilterHeaders([]); $getFilterHeaders->xAcsDingtalkAccessToken = ""; $getFilterRequest = new GetFilterRequest([ "operatorId" => "ppgAxxx" ]); try { $client->getFilterWithOptions("e54Lq3xxx", "Sheet1", $getFilterRequest, $getFilterHeaders, 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 dapat membantu developer melacak 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)); ``` Go ```go theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 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 } getFilterHeaders := &dingtalkdoc_1_0.GetFilterHeaders{} getFilterHeaders.XAcsDingtalkAccessToken = tea.String("") getFilterRequest := &dingtalkdoc_1_0.GetFilterRequest{ OperatorId: tea.String("ppgAxxx"), } tryErr := func()(_e error) { defer func() { if r := tea.Recover(recover()); r != nil { _e = r } }() _, _err = client.GetFilterWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), getFilterRequest, getFilterHeaders, &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 dapat membantu developer melacak issue } } return _err } func main() { err := _main(tea.StringSlice(os.Args[1:])) if err != nil { panic(err) } } ``` Node.js ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} 'use strict'; // File ini dibuat otomatis, jangan mengeditnya 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 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 getFilterHeaders = new dingtalkdoc_1_0.GetFilterHeaders({ }); getFilterHeaders.xAcsDingtalkAccessToken = ''; let getFilterRequest = new dingtalkdoc_1_0.GetFilterRequest({ operatorId: 'ppgAxxx', }); try { await client.getFilterWithOptions('e54Lq3xxx', 'Sheet1', getFilterRequest, getFilterHeaders, new Util.RuntimeOptions({ })); } catch (err) { if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) { // err berisi Atribut code dan message, yang dapat membantu developer melacak issue } } } } exports.Client = Client; Client.main(process.argv.slice(2)); ``` C# ```java theme={"theme":{"light":"github-light","dark":"github-dark"}} 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 { /// Description: /// /// Initialize the account Client with the token /// /// /// /// Client /// /// /// Exception: /// 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.GetFilterHeaders getFilterHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterHeaders(); getFilterHeaders.XAcsDingtalkAccessToken = ""; AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterRequest getFilterRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.GetFilterRequest { OperatorId = "ppgAxxx", }; try { client.GetFilterWithOptions("e54Lq3xxx", "Sheet1", getFilterRequest, getFilterHeaders, 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 dapat membantu developer melacak issue } } catch (Exception _err) { TeaException err = new TeaException(new Dictionary { { "message", _err.Message } }); if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message)) { // err berisi Atribut code dan message, yang dapat membantu developer melacak issue } } } } } ``` ## Respons ### Isi respons | Nama | Tipe | Deskripsi | | ----------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | id | String | Pengidentifikasi unik dari filter. | | range | String | Rentang filter dalam notasi A1. | | criteria | `Map` | Pemetaan kondisi filter untuk semua kolom. Key adalah offset kolom (relatif terhadap kolom pertama dari rentang filter, dimulai dari 0), dan value adalah object kondisi filter untuk kolom tersebut. Jika tidak ada kondisi filter yang diatur, sebuah object kosong `{}` akan dikembalikan. | | | Object | Kondisi filter dari kolom saat ini. | | filterType | String | Tipe filter. Nilai yang valid: - **values**: filter berdasarkan nilai. - **color**: filter berdasarkan warna. - **condition**: filter berdasarkan kondisi. | | visibleValues | Array of String | Nilai yang terlihat. | | conditions | Array | Daftar kondisi saat memfilter berdasarkan kondisi. Dikembalikan hanya ketika `filterType` bernilai `condition`. | | operator | String | 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 | Nilai kondisi. | | conditionOperator | String | Hubungan logis antara beberapa kondisi (`and` atau `or`). Dikembalikan hanya ketika `filterType` bernilai `condition`. | | backgroundColor | String | Warna yang terlihat saat memfilter berdasarkan warna latar belakang, dalam format heksadesimal. Dikembalikan hanya ketika `filterType` bernilai `color` dan memfilter berdasarkan warna latar belakang. | | fontColor | String | Warna yang terlihat saat memfilter berdasarkan warna font, dalam format heksadesimal. Dikembalikan hanya ketika `filterType` bernilai `color` dan memfilter berdasarkan warna font. | ### Contoh isi respons ```text theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK Content-Type:application/json { "id": "filter-xxxxx", "range": "A1:D10", "criteria": { "key": { "filterType": "values", "visibleValues": [ "123" ], } } } ``` ### Kode error Jika terjadi error saat memanggil API ini, cari pesan error di dokumentasi [Kode error global](/id/open/development/server-api-error-codes-1) untuk menemukan solusinya. | HttpCode | Kode error | Pesan error | Deskripsi | | -------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | 400 | invalidRequest.inputArgs.invalid | %s | Parameter permintaan tidak valid. Tinjau 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 melakukan tindakan ini. | | 403 | forbidden.acrossOrg | %s | Permintaan tidak valid. Periksa apakah dokumen target termasuk dalam Organisasi yang ditentukan oleh access token. | | 403 | forbidden.operationIllegal | %s | Tindakan permintaan tidak valid. Tinjau 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 target 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. |