開発ガイドリクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/doc/workbooks/{workbookId}/sheets/{sheetId}/filterViews/{filterViewId} |
| HTTP Method | PATCH |
| サポートされるアプリタイプ | appType-社内アプリ |
| 権限要件 | permission-Document.Workbook.Write-スプレッドシート書き込み権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 当該インターフェースを呼び出すためのアクセス認証情報。社内アプリの access_token を取得する インターフェースを呼び出して取得できます。 |
パスパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| workbookId | String | はい | スプレッドシートファイル ID。ナレッジベース API が返す nodeId(dentryUuid) がスプレッドシートの workbookId です。ノードの取得 および ナレッジベースドキュメントの作成 インターフェースを呼び出して取得できます。 |
| sheetId | String | はい | ワークシート ID または名前。すべてのワークシートを取得する インターフェースを呼び出して id または name パラメータ値を取得できます。 |
| filterViewId | String | はい | フィルタービューの ID。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| operatorId | String | はい | 操作者の unionId。 - サイレントログインコードによるユーザー情報取得 インターフェースで unionid パラメータ値を取得できます。 - ユーザー詳細の照会 インターフェースを呼び出して unionid パラメータ値を取得できます。 操作者に権限がない場合、インターフェースは The operator has no permission というエラーを返します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | String | いいえ | フィルタービューの新しい名前。指定しない場合は名前を更新しません。 |
| range | String | いいえ | フィルタービューの新しい範囲。A1 表記を使用します。指定しない場合は範囲を更新しません。 |
| criteria | Map<String, Object> | いいえ | 更新が必要な列のフィルター。key は列のオフセット（range の先頭列を基準とし、0 から始まる）、value はフィルターオブジェクトです。指定された列のみが更新され、他の列の既存のフィルターには影響しません。指定しない場合はフィルターを更新しません。 |
| Object | いいえ | 当該列のフィルターオブジェクト | |
| filterType | String | いいえ | フィルタータイプ。指定可能な値： - values：値で絞り込み - color：色で絞り込み - condition：条件で絞り込み |
| visibleValues | Array of String | いいえ | 表示する値 |
| conditions | Array | いいえ | 条件で絞り込む場合、指定するフィルター条件のリスト。filterType が condition の場合のみ有効です。各条件オブジェクトには operator（演算子）と value（条件値）フィールドが含まれます。 |
| 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（または）。デフォルトは and です。filterType が condition で、かつ複数条件がある場合のみ有効です。 |
| backgroundColor | String | いいえ | 背景色で絞り込む場合に指定する色値（16 進数、例：#FF0000）。filterType が color の場合のみ有効で、fontColor と択一です。 |
| fontColor | String | いいえ | フォント色で絞り込む場合に指定する色値（16 進数、例：#FF0000）。filterType が color の場合のみ有効で、backgroundColor と択一です。 |
リクエスト例
HTTPPATCH /v1.0/doc/workbooks/e54Lq3xxx/sheets/Sheet1/filterViews/fv-xxxxx?operatorId=ppgAxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:f86e0bxxx
Content-Type:application/json
{
"name" : "売上データフィルター",
"range" : "A1:E20",
"criteria" : {
"key" : {
"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.UpdateFilterViewHeaders updateFilterViewHeaders = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewHeaders();
updateFilterViewHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue.CriteriaValueConditions()
.setOperator("or")
.setValue("20");
com.aliyun.dingtalkdoc_1_0.models.CriteriaValue criteriaValueKey = new com.aliyun.dingtalkdoc_1_0.models.CriteriaValue()
.setFilterType("values")
.setVisibleValues(java.util.Arrays.asList(
"123"
))
.setConditions(java.util.Arrays.asList(
criteriaValueKeyConditions0
))
.setConditionOperator("or")
.setBackgroundColor("#FF0000")
.setFontColor("#FF0000");
java.util.Map<String, com.aliyun.dingtalkdoc_1_0.models.CriteriaValue> criteria = TeaConverter.buildMap(
new TeaPair("criteriaValueKey", criteriaValueKey)
);
com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewRequest updateFilterViewRequest = new com.aliyun.dingtalkdoc_1_0.models.UpdateFilterViewRequest()
.setOperatorId("ppgAxxx")
.setName("売上データフィルター")
.setRange("A1:E20")
.setCriteria(criteria);
try {
client.updateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", updateFilterViewRequest, updateFilterViewHeaders, 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()
update_filter_view_headers = dingtalkdoc__1__0_models.UpdateFilterViewHeaders()
update_filter_view_headers.x_acs_dingtalk_access_token = '<your access token>'
criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions(
operator='or',
value='20'
)
criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
filter_type='values',
visible_values=[
'123'
],
conditions=[
criteria_value_key_conditions_0
],
condition_operator='or',
background_color='#FF0000',
font_color='#FF0000'
)
criteria = {
'criteriaValueKey': criteria_value_key
}
update_filter_view_request = dingtalkdoc__1__0_models.UpdateFilterViewRequest(
operator_id='ppgAxxx',
name='売上データフィルター',
range='A1:E20',
criteria=criteria
)
try:
client.update_filter_view_with_options('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', update_filter_view_request, update_filter_view_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()
update_filter_view_headers = dingtalkdoc__1__0_models.UpdateFilterViewHeaders()
update_filter_view_headers.x_acs_dingtalk_access_token = '<your access token>'
criteria_value_key_conditions_0 = dingtalkdoc__1__0_models.CriteriaValueConditions(
operator='or',
value='20'
)
criteria_value_key = dingtalkdoc__1__0_models.CriteriaValue(
filter_type='values',
visible_values=[
'123'
],
conditions=[
criteria_value_key_conditions_0
],
condition_operator='or',
background_color='#FF0000',
font_color='#FF0000'
)
criteria = {
'criteriaValueKey': criteria_value_key
}
update_filter_view_request = dingtalkdoc__1__0_models.UpdateFilterViewRequest(
operator_id='ppgAxxx',
name='売上データフィルター',
range='A1:E20',
criteria=criteria
)
try:
await client.update_filter_view_with_options_async('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', update_filter_view_request, update_filter_view_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\UpdateFilterViewHeaders;
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\UpdateFilterViewRequest;
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();
$updateFilterViewHeaders = new UpdateFilterViewHeaders([]);
$updateFilterViewHeaders->xAcsDingtalkAccessToken = "<your access token>";
$criteriaValueKeyConditions0 = new conditions([
"operator" => "or",
"value" => "20"
]);
$criteriaValueKey = new CriteriaValue([
"filterType" => "values",
"visibleValues" => [
"123"
],
"conditions" => [
$criteriaValueKeyConditions0
],
"conditionOperator" => "or",
"backgroundColor" => "#FF0000",
"fontColor" => "#FF0000"
]);
$criteria = [
"criteriaValueKey" => $criteriaValueKey
];
$updateFilterViewRequest = new UpdateFilterViewRequest([
"operatorId" => "ppgAxxx",
"name" => "売上データフィルター",
"range" => "A1:E20",
"criteria" => $criteria
]);
try {
$client->updateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", $updateFilterViewRequest, $updateFilterViewHeaders, 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
}
updateFilterViewHeaders := &dingtalkdoc_1_0.UpdateFilterViewHeaders{}
updateFilterViewHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
criteriaValueKeyConditions0 := &dingtalkdoc_1_0.CriteriaValueConditions{
Operator: tea.String("or"),
Value: tea.String("20"),
}
criteriaValueKey := &dingtalkdoc_1_0.CriteriaValue{
FilterType: tea.String("values"),
VisibleValues: []*string{tea.String("123")},
Conditions: []*dingtalkdoc_1_0.CriteriaValueConditions{criteriaValueKeyConditions0},
ConditionOperator: tea.String("or"),
BackgroundColor: tea.String("#FF0000"),
FontColor: tea.String("#FF0000"),
}
criteria := map[string]*dingtalkdoc_1_0.CriteriaValue{
"criteriaValueKey": criteriaValueKey,
}
updateFilterViewRequest := &dingtalkdoc_1_0.UpdateFilterViewRequest{
OperatorId: tea.String("ppgAxxx"),
Name: tea.String("売上データフィルター"),
Range: tea.String("A1:E20"),
Criteria: criteria,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateFilterViewWithOptions(tea.String("e54Lq3xxx"), tea.String("Sheet1"), tea.String("fv-xxxxx"), updateFilterViewRequest, updateFilterViewHeaders, &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 updateFilterViewHeaders = new dingtalkdoc_1_0.UpdateFilterViewHeaders({ });
updateFilterViewHeaders.xAcsDingtalkAccessToken = '<your access token>';
let criteriaValueKeyConditions0 = new dingtalkdoc_1_0.CriteriaValueConditions({
operator: 'or',
value: '20',
});
let criteriaValueKey = new dingtalkdoc_1_0.CriteriaValue({
filterType: 'values',
visibleValues: [
'123'
],
conditions: [
criteriaValueKeyConditions0
],
conditionOperator: 'or',
backgroundColor: '#FF0000',
fontColor: '#FF0000',
});
let criteria = {
criteriaValueKey: criteriaValueKey,
};
let updateFilterViewRequest = new dingtalkdoc_1_0.UpdateFilterViewRequest({
operatorId: 'ppgAxxx',
name: '売上データフィルター',
range: 'A1:E20',
criteria: criteria,
});
try {
await client.updateFilterViewWithOptions('e54Lq3xxx', 'Sheet1', 'fv-xxxxx', updateFilterViewRequest, updateFilterViewHeaders, 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.UpdateFilterViewHeaders updateFilterViewHeaders = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterViewHeaders();
updateFilterViewHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions criteriaValueKeyConditions0 = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions
{
Operator = "or",
Value = "20",
};
AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue criteriaValueKey = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue
{
FilterType = "values",
VisibleValues = new List<string>
{
"123"
},
Conditions = new List<AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.CriteriaValue.CriteriaValueConditions>
{
criteriaValueKeyConditions0
},
ConditionOperator = "or",
BackgroundColor = "#FF0000",
FontColor = "#FF0000",
};
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.UpdateFilterViewRequest updateFilterViewRequest = new AlibabaCloud.SDK.Dingtalkdoc_1_0.Models.UpdateFilterViewRequest
{
OperatorId = "ppgAxxx",
Name = "売上データフィルター",
Range = "A1:E20",
Criteria = criteria,
};
try
{
client.UpdateFilterViewWithOptions("e54Lq3xxx", "Sheet1", "fv-xxxxx", updateFilterViewRequest, updateFilterViewHeaders, 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。 |
| name | String | 更新後のフィルタービュー名。 |
| range | String | 更新後のフィルタービュー範囲。A1 表記。 |
レスポンスボディ例
HTTP/1.1 200 OK
Content-Type:application/json
{
"id" : "fv-xxxxx",
"name" : "売上データフィルター",
"range" : "A1:E20"
}
エラーコード
当該インターフェースを呼び出してエラーが発生した場合、エラーメッセージに基づいて グローバルエラーコード ドキュメントで解決策を検索してください。| 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 | リクエストが不正です。アクセス対象のドキュメントがアクセストークンで指定された組織に所属しているかをご確認ください。 |
| 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. | サービス内部エラーです。後で再試行してください。 |