Deskripsi panggilan API
Setelah panggilan API berhasil, baris yang sebelumnya disembunyikan oleh kriteria filter kolom tersebut akan ditampilkan kembali, selama baris tersebut tidak disembunyikan oleh kriteria filter kolom lain.Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filter/clearColumnFilterCriteria |
| 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 dari Spreadsheet. Anda dapat memperolehnya dengan memanggil API Get 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 dari operator. - Anda dapat memanggil API Mendapatkan informasi pengguna melalui kode login senyap untuk memperoleh nilai parameter unionid. - Anda dapat memanggil API Kueri 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 |
|---|---|---|---|
| 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. |
Contoh permintaan
HTTPPOST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filter/clearColumnFilterCriteria?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json
{
"column" : 0
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with 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.ClearFilterCriteriaHeaders clearFilterCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterCriteriaHeaders();
clearFilterCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.ClearFilterCriteriaRequest clearFilterCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.ClearFilterCriteriaRequest()
.setOperatorId("ppgAxxx")
.setColumn(0L);
try {
client.clearFilterCriteriaWithOptions("e54Lq3xxx", "Sheet1", clearFilterCriteriaRequest, clearFilterCriteriaHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// The err contains the code and message attributes, which can help developers locate issues
}
} 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)) {
// The err contains the code and message attributes, which can help developers locate issues
}
}
}
}
# -*- 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 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()
clear_filter_criteria_headers = dingtalkdoc__1__0_models.ClearFilterCriteriaHeaders()
clear_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
clear_filter_criteria_request = dingtalkdoc__1__0_models.ClearFilterCriteriaRequest(
operator_id='ppgAxxx',
column=0
)
try:
client.clear_filter_criteria_with_options('e54Lq3xxx', 'Sheet1', clear_filter_criteria_request, clear_filter_criteria_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which can help developers locate issues
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
clear_filter_criteria_headers = dingtalkdoc__1__0_models.ClearFilterCriteriaHeaders()
clear_filter_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
clear_filter_criteria_request = dingtalkdoc__1__0_models.ClearFilterCriteriaRequest(
operator_id='ppgAxxx',
column=0
)
try:
await client.clear_filter_criteria_with_options_async('e54Lq3xxx', 'Sheet1', clear_filter_criteria_request, clear_filter_criteria_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# The err contains the code and message attributes, which can help developers locate issues
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?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\ClearFilterCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\ClearFilterCriteriaRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with 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();
$clearFilterCriteriaHeaders = new ClearFilterCriteriaHeaders([]);
$clearFilterCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
$clearFilterCriteriaRequest = new ClearFilterCriteriaRequest([
"operatorId" => "ppgAxxx",
"column" => 0
]);
try {
$client->clearFilterCriteriaWithOptions("e54Lq3xxx", "Sheet1", $clearFilterCriteriaRequest, $clearFilterCriteriaHeaders, 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)) {
// The err contains the code and message attributes, which can help developers locate issues
}
}
}
}
$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 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
}
clearFilterCriteriaHeaders := &dingtalkdoc_1_0.ClearFilterCriteriaHeaders{}
clearFilterCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
clearFilterCriteriaRequest := &dingtalkdoc_1_0.ClearFilterCriteriaRequest{
OperatorId: tea.String("ppgAxxx"),
Column: tea.Int64(0),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.ClearFilterCriteriaWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), clearFilterCriteriaRequest, clearFilterCriteriaHeaders, &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)) {
// The err contains the code and message attributes, which can help developers locate issues
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
'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 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 clearFilterCriteriaHeaders = new dingtalkdoc_1_0.ClearFilterCriteriaHeaders({ });
clearFilterCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
let clearFilterCriteriaRequest = new dingtalkdoc_1_0.ClearFilterCriteriaRequest({
operatorId: 'ppgAxxx',
column: 0,
});
try {
await client.clearFilterCriteriaWithOptions('e54Lq3xxx', 'Sheet1', clearFilterCriteriaRequest, clearFilterCriteriaHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// The err contains the code and message attributes, which can help developers locate issues
}
}
}
}
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 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.ClearFilterCriteriaHeaders clearFilterCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterCriteriaHeaders();
clearFilterCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterCriteriaRequest clearFilterCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.ClearFilterCriteriaRequest
{
OperatorId = "ppgAxxx",
Column = 0,
};
try
{
client.ClearFilterCriteriaWithOptions("e54Lq3xxx", "Sheet1", clearFilterCriteriaRequest, clearFilterCriteriaHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// The err contains the code and message attributes, which can help developers locate issues
}
}
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))
{
// The err contains the code and message attributes, which can help developers locate issues
}
}
}
}
}
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" : "filter-xxxxx"
}
Kode error
Jika terjadi error 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. 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 operasi 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. 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 konten Spreadsheet. |
| 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. |