API call description
- When the storage space type is USER, all users with permissions on the space have operation permissions. Other employees must call the Add permissions API to obtain authorization.
- When the storage space type is APP, anyone performing the operation must call the Add permissions API to obtain authorization.
Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/appProperties/remove |
| HTTP Method | POST |
| Supported app types | appType-Internal app appType-Third-party enterprise app |
| Permission requirements | permission-Storage.File.Write-Organization storage file write permission |
Request header
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. Obtain it as follows: - For an internal app, call the Get the access token of an internal app API. - For a third-party enterprise app, call the Get the access token of an organization authorized to a third-party app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| spaceId | Long | Yes | The space ID. Call the Add a space API to obtain the value of the id parameter. |
| dentryId | Long | Yes | The ID of the file or folder. Call the Get a list of files or folders or Get spaceId and dentryId by dentryUuid API to obtain the value of the id parameter. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| unionId | String | Yes | The unionId of the operator. Call the Query user details API to obtain the value of the unionid parameter. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| propertyNames | Array of String | Yes | The list of app property names of the file or folder. The maximum number is 3. |
Request example
HTTPPOST /v1.0/storage/spaces/854xxxxx/dentries/634xxxxx/appProperties/remove?unionId=cHtUxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json
{
"propertyNames" : [ "Attribute2" ]
}
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* <b>description</b> :
* <p>Initialize the account Client with a Token</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.DeleteDentryAppPropertiesHeaders deleteDentryAppPropertiesHeaders = new com.aliyun.dingtalkstorage_1_0.models.DeleteDentryAppPropertiesHeaders();
deleteDentryAppPropertiesHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkstorage_1_0.models.DeleteDentryAppPropertiesRequest deleteDentryAppPropertiesRequest = new com.aliyun.dingtalkstorage_1_0.models.DeleteDentryAppPropertiesRequest()
.setUnionId("cHtUxxxxx")
.setPropertyNames(java.util.Arrays.asList(
"Attribute2"
));
try {
client.deleteDentryAppPropertiesWithOptions("", "", deleteDentryAppPropertiesRequest, deleteDentryAppPropertiesHeaders, 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 contains the code and message attributes, which help locate the 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 contains the code and message attributes, which help locate the issue
}
}
}
}
# -*- 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:
"""
Initialize the account Client with a Token
@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()
delete_dentry_app_properties_headers = dingtalkstorage__1__0_models.DeleteDentryAppPropertiesHeaders()
delete_dentry_app_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
delete_dentry_app_properties_request = dingtalkstorage__1__0_models.DeleteDentryAppPropertiesRequest(
union_id='cHtUxxxxx',
property_names=[
'Attribute2'
]
)
try:
client.delete_dentry_app_properties_with_options('', '', delete_dentry_app_properties_request, delete_dentry_app_properties_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes, which help locate the issue
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
delete_dentry_app_properties_headers = dingtalkstorage__1__0_models.DeleteDentryAppPropertiesHeaders()
delete_dentry_app_properties_headers.x_acs_dingtalk_access_token = '<your access token>'
delete_dentry_app_properties_request = dingtalkstorage__1__0_models.DeleteDentryAppPropertiesRequest(
union_id='cHtUxxxxx',
property_names=[
'Attribute2'
]
)
try:
await client.delete_dentry_app_properties_with_options_async('', '', delete_dentry_app_properties_request, delete_dentry_app_properties_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err contains the code and message attributes, which help locate the issue
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\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\DeleteDentryAppPropertiesHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\DeleteDentryAppPropertiesRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Initialize the account Client with a 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();
$deleteDentryAppPropertiesHeaders = new DeleteDentryAppPropertiesHeaders([]);
$deleteDentryAppPropertiesHeaders->xAcsDingtalkAccessToken = "<your access token>";
$deleteDentryAppPropertiesRequest = new DeleteDentryAppPropertiesRequest([
"unionId" => "cHtUxxxxx",
"propertyNames" => [
"Attribute2"
]
]);
try {
$client->deleteDentryAppPropertiesWithOptions("", "", $deleteDentryAppPropertiesRequest, $deleteDentryAppPropertiesHeaders, 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 contains the code and message attributes, which help locate the 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));
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:
//
// Initialize the account Client with a Token
//
// @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
}
deleteDentryAppPropertiesHeaders := &dingtalkstorage_1_0.DeleteDentryAppPropertiesHeaders{}
deleteDentryAppPropertiesHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
deleteDentryAppPropertiesRequest := &dingtalkstorage_1_0.DeleteDentryAppPropertiesRequest{
UnionId: tea.String("cHtUxxxxx"),
PropertyNames: []*string{tea.String("Attribute2")},
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.DeleteDentryAppPropertiesWithOptions(tea.String(""), tea.String(""), deleteDentryAppPropertiesRequest, deleteDentryAppPropertiesHeaders, &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 contains the code and message attributes, which help locate the issue
}
}
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 dingtalkstorage_1_0 = require('@alicloud/dingtalk/storage_1_0');
const OpenApi = require('@alicloud/openapi-client');
const Tea = require('@alicloud/tea-typescript');
class Client {
/**
* Initialize the account Client with a Token
* @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 deleteDentryAppPropertiesHeaders = new dingtalkstorage_1_0.DeleteDentryAppPropertiesHeaders({ });
deleteDentryAppPropertiesHeaders.xAcsDingtalkAccessToken = '<your access token>';
let deleteDentryAppPropertiesRequest = new dingtalkstorage_1_0.DeleteDentryAppPropertiesRequest({
unionId: 'cHtUxxxxx',
propertyNames: [
'Attribute2'
],
});
try {
await client.deleteDentryAppPropertiesWithOptions('', '', deleteDentryAppPropertiesRequest, deleteDentryAppPropertiesHeaders, new Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
// err contains the code and message attributes, which help locate the issue
}
}
}
}
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 a Token</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.DeleteDentryAppPropertiesHeaders deleteDentryAppPropertiesHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentryAppPropertiesHeaders();
deleteDentryAppPropertiesHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentryAppPropertiesRequest deleteDentryAppPropertiesRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.DeleteDentryAppPropertiesRequest
{
UnionId = "cHtUxxxxx",
PropertyNames = new List<string>
{
"Attribute2"
},
};
try
{
client.DeleteDentryAppPropertiesWithOptions("", "", deleteDentryAppPropertiesRequest, deleteDentryAppPropertiesHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err contains the code and message attributes, which help locate the issue
}
}
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 contains the code and message attributes, which help locate the issue
}
}
}
}
}
Response
Response body
| Name | Type | Description |
|---|---|---|
| success | Boolean | Whether the deletion succeeded. - true: Success - false: Failed |
Response body example
HTTP/1.1 200 OK
Content-Type:application/json
{
"success" : true
}
Error codes
If an error occurs when calling this API, find the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 400 | operationConcurrentControl | %s | Concurrency control |
| 400 | paramError | %s | Parameter error |
| 400 | paramError.spaceId | %s | Parameter error - spaceId |
| 400 | paramError.dentryId | %s | Parameter error - dentryId |
| 400 | dentryAppPropertiesNumberExceedsLimit | %s | The number of app properties deleted from a single dentry exceeds the limit. The maximum is 3. |
| 403 | permissionDenied | %s | The user does not have permission to obtain file (folder) information. |
| 404 | spaceNotExist | %s | The space does not exist. |
| 404 | dentryNotExist | %s | The file does not exist. |
| 500 | systemError | %s | System error |
| 500 | unknownError | Unknown Error | Unknown error |
| 503 | operationTimeout | %s | Request timed out |