接口调用说明
筛选视图的条件仅影响当前视图,不会改变其他用户看到的数据。请求
基本信息
| 字段 | 值 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId}/setColumnFilterCriteria |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 |
| 权限要求 | permission-Document.Workbook.Write-钉钉表格写权限 |
请求头
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证,可调用获取企业内部应用的accessToken接口获取。 |
路径参数
查询参数
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| operatorId | String | 是 | 操作人的unionId。 - 可通过通过免登码获取用户信息接口获取unionid参数值。 - 可调用查询用户详情接口获取unionid参数值。 若操作人无权限,接口会报错The operator has no permission。 |
请求体
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| column | Long | 是 | 列偏移量,相对于筛选视图范围首列,从 0 开始。例如筛选视图范围为 B1:E10,则 column=0 代表 B 列,column=1 代表 C 列。 |
| filterCriteria | Object | 是 | 筛选条件对象。 |
| filterType | String | 是 | 筛选类型。可选值: - values:按值筛选 - color:按颜色筛选 - condition:按条件筛选 |
| visibleValues | Array of String | 否 | 可见值 |
| backgroundColor | String | 否 | 按背景色筛选时的可见颜色,16 进制格式(如 #FF0000)。当 filterType 为 color 时,backgroundColor 和 fontColor 二选一必填。 |
| fontColor | String | 否 | 按字体色筛选时的可见颜色,16 进制格式(如 #00FF00)。当 filterType 为 color 时,backgroundColor 和 fontColor 二选一必填。 |
| conditions | Array | 否 | 按条件筛选时的条件列表,最多 2 个条件。当 filterType 为 condition 时必填。 |
| operator | String | 否 | 条件操作符。取值: - equal:等于 - not-equal:不等于 - contains:包含 - not-contains:不包含 - starts-with:开头是 - not-starts-with:开头不是 - ends-with:结尾是 - not-ends-with:结尾不是 - greater:大于 - greater-equal:大于等于 - less:小于 - less-equal:小于等于 |
| value | String | 否 | 条件值 |
| conditionOperator | String | 否 | 多个条件之间的逻辑关系。取值: * and:且(默认值) * or:或。 当 conditions 包含 2 个条件时生效。 |
请求示例
HTTPPOST /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filterViews/fv-xxxxx/setColumnFilterCriteria?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json
{
"column" : 0,
"filterCriteria" : {
"filterType" : "values",
"visibleValues" : [ "123" ],
}
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>使用 Token 初始化账号Client</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.SetFilterViewCriteriaHeaders setFilterViewCriteriaHeaders = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaHeaders();
setFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteriaConditions()
.setOperator("less")
.setValue("20");
com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria filterCriteria = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria()
.setFilterType("values")
.setVisibleValues(java.util.Arrays.asList(
"123"
))
.setBackgroundColor("#FF0000")
.setFontColor("#FF0000")
.setConditions(java.util.Arrays.asList(
filterCriteriaConditions0
))
.setConditionOperator("or");
com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest setFilterViewCriteriaRequest = new com.aliyun.dingtalkdoc_1_0.models.SetFilterViewCriteriaRequest()
.setOperatorId("ppgAxxx")
.setColumn(0L)
.setFilterCriteria(filterCriteria);
try {
client.setFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, 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 中含有 code 和 message 属性,可帮助开发定位问题
}
} 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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
# -*- 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:
"""
使用 Token 初始化账号Client
@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()
set_filter_view_criteria_headers = dingtalkdoc__1__0_models.SetFilterViewCriteriaHeaders()
set_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteriaConditions(
operator='less',
value='20'
)
filter_criteria = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteria(
filter_type='values',
visible_values=[
'123'
],
background_color='#FF0000',
font_color='#FF0000',
conditions=[
filter_criteria_conditions_0
],
condition_operator='or'
)
set_filter_view_criteria_request = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequest(
operator_id='ppgAxxx',
column=0,
filter_criteria=filter_criteria
)
try:
client.set_filter_view_criteria_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', set_filter_view_criteria_request, set_filter_view_criteria_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err 中含有 code 和 message 属性,可帮助开发定位问题
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
set_filter_view_criteria_headers = dingtalkdoc__1__0_models.SetFilterViewCriteriaHeaders()
set_filter_view_criteria_headers.x_acs_dingtalk_access_token = '<your access token>'
filter_criteria_conditions_0 = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteriaConditions(
operator='less',
value='20'
)
filter_criteria = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequestFilterCriteria(
filter_type='values',
visible_values=[
'123'
],
background_color='#FF0000',
font_color='#FF0000',
conditions=[
filter_criteria_conditions_0
],
condition_operator='or'
)
set_filter_view_criteria_request = dingtalkdoc__1__0_models.SetFilterViewCriteriaRequest(
operator_id='ppgAxxx',
column=0,
filter_criteria=filter_criteria
)
try:
await client.set_filter_view_criteria_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', set_filter_view_criteria_request, set_filter_view_criteria_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err 中含有 code 和 message 属性,可帮助开发定位问题
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\SetFilterViewCriteriaHeaders;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest\filterCriteria\conditions;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest\filterCriteria;
use AlibabaCloud\SDK\Dingtalk\Vdoc_1_0\Models\SetFilterViewCriteriaRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* 使用 Token 初始化账号Client
* @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();
$setFilterViewCriteriaHeaders = new SetFilterViewCriteriaHeaders([]);
$setFilterViewCriteriaHeaders->xAcsDingtalkAccessToken = "<your access token>";
$filterCriteriaConditions0 = new conditions([
"operator" => "less",
"value" => "20"
]);
$filterCriteria = new filterCriteria([
"filterType" => "values",
"visibleValues" => [
"123"
],
"backgroundColor" => "#FF0000",
"fontColor" => "#FF0000",
"conditions" => [
$filterCriteriaConditions0
],
"conditionOperator" => "or"
]);
$setFilterViewCriteriaRequest = new SetFilterViewCriteriaRequest([
"operatorId" => "ppgAxxx",
"column" => 0,
"filterCriteria" => $filterCriteria
]);
try {
$client->setFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $setFilterViewCriteriaRequest, $setFilterViewCriteriaHeaders, 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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
$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:
//
// 使用 Token 初始化账号Client
//
// @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
}
setFilterViewCriteriaHeaders := &dingtalkdoc_1_0.SetFilterViewCriteriaHeaders{}
setFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
filterCriteriaConditions0 := &dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions{
Operator: tea.String("less"),
Value: tea.String("20"),
}
filterCriteria := &dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteria{
FilterType: tea.String("values"),
VisibleValues: []*string{tea.String("123")},
BackgroundColor: tea.String("#FF0000"),
FontColor: tea.String("#FF0000"),
Conditions: []*dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions{filterCriteriaConditions0},
ConditionOperator: tea.String("or"),
}
setFilterViewCriteriaRequest := &dingtalkdoc_1_0.SetFilterViewCriteriaRequest{
OperatorId: tea.String("ppgAxxx"),
Column: tea.Int64(0),
FilterCriteria: filterCriteria,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.SetFilterViewCriteriaWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, &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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
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 {
/**
* 使用 Token 初始化账号Client
* @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 setFilterViewCriteriaHeaders = new dingtalkdoc_1_0.SetFilterViewCriteriaHeaders({ });
setFilterViewCriteriaHeaders.xAcsDingtalkAccessToken = '<your access token>';
let filterCriteriaConditions0 = new dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteriaConditions({
operator: 'less',
value: '20',
});
let filterCriteria = new dingtalkdoc_1_0.SetFilterViewCriteriaRequestFilterCriteria({
filterType: 'values',
visibleValues: [
'123'
],
backgroundColor: '#FF0000',
fontColor: '#FF0000',
conditions: [
filterCriteriaConditions0
],
conditionOperator: 'or',
});
let setFilterViewCriteriaRequest = new dingtalkdoc_1_0.SetFilterViewCriteriaRequest({
operatorId: 'ppgAxxx',
column: 0,
filterCriteria: filterCriteria,
});
try {
await client.setFilterViewCriteriaWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
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>使用 Token 初始化账号Client</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.SetFilterViewCriteriaHeaders setFilterViewCriteriaHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaHeaders();
setFilterViewCriteriaHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions filterCriteriaConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions
{
Operator = "less",
Value = "20",
};
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria filterCriteria = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria
{
FilterType = "values",
VisibleValues = new List<string>
{
"123"
},
BackgroundColor = "#FF0000",
FontColor = "#FF0000",
Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest.SetFilterViewCriteriaRequestFilterCriteria.SetFilterViewCriteriaRequestFilterCriteriaConditions>
{
filterCriteriaConditions0
},
ConditionOperator = "or",
};
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest setFilterViewCriteriaRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.SetFilterViewCriteriaRequest
{
OperatorId = "ppgAxxx",
Column = 0,
FilterCriteria = filterCriteria,
};
try
{
client.SetFilterViewCriteriaWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", setFilterViewCriteriaRequest, setFilterViewCriteriaHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err 中含有 code 和 message 属性,可帮助开发定位问题
}
}
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 中含有 code 和 message 属性,可帮助开发定位问题
}
}
}
}
}
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 筛选视图的唯一标识 ID |
响应体示例
HTTP/1.1 200 OK
Content-Type:application/json
{
"id" : "fv-xxxxx"
}
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| HttpCode | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | invalidRequest.inputArgs.invalid | %s | 请求参数不合法,请查看错误信息。 |
| 400 | invalidRequest.inputArgs.workbookIdIllegal | The workbookId is illegal. | workbookId不合法。 |
| 400 | invalidRequest.resource.notWorkbook | %s | 不支持的文档类型,请检查workbookId。 |
| 400 | invalidRequest.document.stillInitializing | The document is still initializing. Please try again later. | 文档初始化中,请稍后重试。 |
| 403 | forbidden.accessDenied | The operator has no permission. | 当前用户无此操作权限。 |
| 403 | forbidden.acrossOrg | %s | 请求不合法,请检查要访问的文档是否归属于accessToken指定的组织。 |
| 403 | forbidden.operationIllegal | %s | 请求操作不合法,请查看错误信息。 |
| 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. | 表格内容过大,请尝试缩减表格内容。 |
| 404 | invalidRequest.resource.notFound | %s | 请求失败,无法找到要访问的资源。 |
| 500 | serviceBusy | The server is busy and unable to complete your request. Please try again later. | 服务繁忙,请稍后重试。 |
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | 服务内部错误,请稍后再试。 |