ファイルまたはフォルダーのアプリ属性を更新する

本 API を呼び出して、ファイルまたはフォルダーのアプリ属性を更新します。

API 呼び出し説明

API に渡されるアプリ属性情報は、属性名に基づいて検証されます。

ファイルまたはフォルダーの既存属性名と API パラメータで渡された属性名が同一の場合、API は属性の更新を実行します。
ファイルまたはフォルダーの既存属性名と API パラメータで渡された属性名が異なる場合、API は属性の追加を実行します。

リクエスト

基本情報

フィールド	値
HTTP URL	`https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/appProperties`
HTTP Method	PUT
サポートするアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
権限要件	permission-Storage.File.Write-企業ストレージファイル書き込み権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	必須	本 API を呼び出すためのアクセス認証情報。以下の方法で取得します。 - 社内アプリの場合、社内アプリの accessToken を取得する API を呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリが権限付与された企業の accessToken を取得する API を呼び出して取得します。

パスパラメータ

名前	タイプ	必須	説明
spaceId	Long	必須	スペース ID。スペースを追加する API を呼び出して id パラメータの値を取得できます。
dentryId	Long	必須	ファイルまたはフォルダーの id。ファイルまたはフォルダーのリストを取得するまたは dentryUuid に基づいて spaceId と dentryId を取得する API を呼び出して id パラメータの値を取得できます。

クエリパラメータ

名前	タイプ	必須	説明
unionId	String	必須	操作者の unionId。ユーザー詳細を照会する API を呼び出して unionid パラメータの値を取得できます。

リクエストボディ

名前	タイプ	必須	説明
appProperties	Array	必須	アプリ属性リスト。最大値は 3 です。
name	String	必須	属性名。 - 属性名が既に存在する場合、既存の属性情報を更新します。 - 属性名が存在しない場合、当該属性情報を追加します。
value	String	必須	属性値。
visibility	String	必須	属性の可視範囲。 - PUBLIC：当該属性はすべての App から参照可能 - PRIVATE：当該属性は所属する App のみ参照可能。デフォルト

リクエスト例

HTTP

PUT /v1.0/storage/spaces/854xxxxx/dentries/634xxxxx/appProperties?unionId=cHtUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "appProperties" : [ {
    "name" : "属性1",
    "value" : "属性値1",
    "visibility" : "PRIVATE"
  } ]
}

Java

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.dingtalkstorage_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.dingtalkstorage_1_0.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesHeaders updateDentryAppPropertiesHeaders = new com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesHeaders();
        updateDentryAppPropertiesHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesRequest.UpdateDentryAppPropertiesRequestAppProperties appProperties0 = new com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesRequest.UpdateDentryAppPropertiesRequestAppProperties()
                .setName("属性1")
                .setValue("属性値1")
                .setVisibility("PRIVATE");
        com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesRequest updateDentryAppPropertiesRequest = new com.aliyun.dingtalkstorage_1_0.models.UpdateDentryAppPropertiesRequest()
                .setUnionId("cHtUxxxxx")
                .setAppProperties(java.util.Arrays.asList(
                    appProperties0
                ));
        try {
            client.updateDentryAppPropertiesWithOptions("", "", updateDentryAppPropertiesRequest, updateDentryAppPropertiesHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
            }

        }        
    }
}

Python

# -*- 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.storage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.storage_1_0 import models as dingtalkstorage__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() -> dingtalkstorage_1_0Client:
        """
        トークンを使用してアカウント Client を初期化します
        @return: Client
        @throws Exception
        """
        config = open_api_models.Config()
        config.protocol = 'https'
        config.region_id = 'central'
        return dingtalkstorage_1_0Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        update_dentry_app_properties_headers = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesHeaders()
        update_dentry_app_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
        app_properties_0 = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesRequestAppProperties(
            name='属性1',
            value='属性値1',
            visibility='PRIVATE'
        )
        update_dentry_app_properties_request = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesRequest(
            union_id='cHtUxxxxx',
            app_properties=[
                app_properties_0
            ]
        )
        try:
            client.update_dentry_app_properties_with_options('', '', update_dentry_app_properties_request, update_dentry_app_properties_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_dentry_app_properties_headers = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesHeaders()
        update_dentry_app_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
        app_properties_0 = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesRequestAppProperties(
            name='属性1',
            value='属性値1',
            visibility='PRIVATE'
        )
        update_dentry_app_properties_request = dingtalkstorage__1__0_models.UpdateDentryAppPropertiesRequest(
            union_id='cHtUxxxxx',
            app_properties=[
                app_properties_0
            ]
        )
        try:
            await client.update_dentry_app_properties_with_options_async('', '', update_dentry_app_properties_request, update_dentry_app_properties_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

<?php

// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;

use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;

use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\UpdateDentryAppPropertiesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\UpdateDentryAppPropertiesRequest\appProperties;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\UpdateDentryAppPropertiesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント 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();
        $updateDentryAppPropertiesHeaders = new UpdateDentryAppPropertiesHeaders([]);
        $updateDentryAppPropertiesHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $appProperties0 = new appProperties([
            "name" => "属性1",
            "value" => "属性値1",
            "visibility" => "PRIVATE"
        ]);
        $updateDentryAppPropertiesRequest = new UpdateDentryAppPropertiesRequest([
            "unionId" => "cHtUxxxxx",
            "appProperties" => [
                $appProperties0
            ]
        ]);
        try {
            $client->updateDentryAppPropertiesWithOptions("", "", $updateDentryAppPropertiesRequest, $updateDentryAppPropertiesHeaders, 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"
  dingtalkstorage_1_0  "github.com/alibabacloud-go/dingtalk/storage_1_0"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  "github.com/alibabacloud-go/tea/tea"
)

// Description:
// 
// トークンを使用してアカウント Client を初期化します
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *dingtalkstorage_1_0.Client, _err error) {
  config := &openapi.Config{}
  config.Protocol = tea.String("https")
  config.RegionId = tea.String("central")
  _result = &dingtalkstorage_1_0.Client{}
  _result, _err = dingtalkstorage_1_0.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }

  updateDentryAppPropertiesHeaders := &dingtalkstorage_1_0.UpdateDentryAppPropertiesHeaders{}
  updateDentryAppPropertiesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  appProperties0 := &dingtalkstorage_1_0.UpdateDentryAppPropertiesRequestAppProperties{
    Name: tea.String("属性1"),
    Value: tea.String("属性値1"),
    Visibility: tea.String("PRIVATE"),
  }
  updateDentryAppPropertiesRequest := &dingtalkstorage_1_0.UpdateDentryAppPropertiesRequest{
    UnionId: tea.String("cHtUxxxxx"),
    AppProperties: []*dingtalkstorage_1_0.UpdateDentryAppPropertiesRequestAppProperties{appProperties0},
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.UpdateDentryAppPropertiesWithOptions(tea.String(""), tea.String(""), updateDentryAppPropertiesRequest, updateDentryAppPropertiesHeaders, &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)
  }
}

Node.js

'use strict';
// This file is auto-generated, don't edit it
const Util = require('@alicloud/tea-util');
const dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');

class Client {

  /**
   * トークンを使用してアカウント Client を初期化します
   * @return Client
   * @throws Exception
   */
  static createClient() {
    let config = new OpenApi.Config({ });
    config.protocol = 'https';
    config.regionId = 'central';
    return new dingtalkstorage_1_0.default(config);
  }

  static async main(args) {
    let client = Client.createClient();
    let updateDentryAppPropertiesHeaders = new dingtalkstorage_1_0.UpdateDentryAppPropertiesHeaders({ });
    updateDentryAppPropertiesHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let appProperties0 = new dingtalkstorage_1_0.UpdateDentryAppPropertiesRequestAppProperties({
      name: '属性1',
      value: '属性値1',
      visibility: 'PRIVATE',
    });
    let updateDentryAppPropertiesRequest = new dingtalkstorage_1_0.UpdateDentryAppPropertiesRequest({
      unionId: 'cHtUxxxxx',
      appProperties: [
        appProperties0
      ],
    });
    try {
      await client.updateDentryAppPropertiesWithOptions('', '', updateDentryAppPropertiesRequest, updateDentryAppPropertiesHeaders, 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>トークンを使用してアカウント Client を初期化します</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Dingtalkstorage_1_0.Client CreateClient()
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
            config.Protocol = "https";
            config.RegionId = "central";
            return new AlibabaCloud.SDK.Dingtalkstorage_1_0.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Client client = CreateClient();
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesHeaders updateDentryAppPropertiesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesHeaders();
            updateDentryAppPropertiesHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesRequest.UpdateDentryAppPropertiesRequestAppProperties appProperties0 = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesRequest.UpdateDentryAppPropertiesRequestAppProperties
            {
                Name = "属性1",
                Value = "属性値1",
                Visibility = "PRIVATE",
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesRequest updateDentryAppPropertiesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesRequest
            {
                UnionId = "cHtUxxxxx",
                AppProperties = new List<AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.UpdateDentryAppPropertiesRequest.UpdateDentryAppPropertiesRequestAppProperties>
                {
                    appProperties0
                },
            };
            try
            {
                client.UpdateDentryAppPropertiesWithOptions("", "", updateDentryAppPropertiesRequest, updateDentryAppPropertiesHeaders, 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 属性が含まれており、開発時の問題特定に役立ちます
                }
            }
        }

    }
}

レスポンス

レスポンスボディ

名前	タイプ	説明
success	Boolean	今回の更新が成功したかどうか。 - true：成功 - false：失敗

レスポンスボディ例

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

{
  "success" : true
}

エラーコード

本 API の呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	operationConcurrentControl	%s	同時実行制御
400	paramError	%s	パラメータエラー
400	paramError.spaceId	%s	パラメータエラー-spaceId
400	paramError.dentryId	%s	パラメータエラー-dentryId
400	dentryAppPropertiesNumberExceedsLimit	%s	dentry 上の単一 App が設定できる属性数が上限を超えています。最大数は 3 です
403	permissionDenied	%s	ユーザーにファイル（フォルダー）属性を変更する権限がありません
404	spaceNotExist	%s	スペースが存在しません
404	dentryNotExist	%s	ファイルが存在しません
500	systemError	%s	システムエラー
500	unknownError	Unknown Error	不明なエラー
503	operationTimeout	%s	リクエストタイムアウト

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

Docs とファイル

IM

ファイルまたはフォルダーのアプリ属性を更新する

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​パスパラメータ

​クエリパラメータ

​リクエストボディ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディ例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

パスパラメータ

クエリパラメータ

リクエストボディ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディ例

エラーコード