Skip to main content
Call this API to restore a recycle item to its original location.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/recycleBins/{recycleBinId}/recycleItems/{recycleItemId}/restore
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.RecycleBin.Write-Write permission for organization storage Recycle Bin

Request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe access credential used to call this API. Obtain it as follows: - For an internal app, call the Obtain the access token of an internal app API. - For a third-party enterprise app, call the Obtain the access token of the authorized enterprise API.

Path parameters

NameTypeRequiredDescription
recycleBinIdStringYesThe ID of the Recycle Bin. Call the Obtain Recycle Bin information API to obtain it.
recycleItemIdStringYesThe ID of the recycle item. Call the Obtain the list of recycle items API to obtain the value of the id parameter.

Query parameters

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain it.

Request body

NameTypeRequiredDescription
optionObjectNoThe optional parameters.
conflictStrategyStringNoThe file name conflict strategy. A file with the same name may already exist at the original path during restoration. - AUTO_RENAME: Automatically rename the file. This is the default value. - OVERWRITE: Overwrite the existing file. - RETURN_DENTRY_IF_EXISTS: Return the existing file. - RETURN_ERROR_IF_EXISTS: Return an error if the file already exists.

Request example

HTTP
POST /v1.0/storage/recycleBins/pQy3Rxxxxx/recycleItems/recycle_item_id/restore?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{
  "option" : {
    "conflictStrategy" : "AUTO_RENAME"
  }
}
Java
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * Initialize the account Client with a Token
     * @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 {
        java.util.List<String> args = java.util.Arrays.asList(args_);
        com.aliyun.dingtalkstorage_1_0.Client client = Sample.createClient();
        com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemHeaders restoreRecycleItemHeaders = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemHeaders();
        restoreRecycleItemHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemRequest.RestoreRecycleItemRequestOption option = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemRequest.RestoreRecycleItemRequestOption()
                .setConflictStrategy("AUTO_RENAME");
        com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemRequest restoreRecycleItemRequest = new com.aliyun.dingtalkstorage_1_0.models.RestoreRecycleItemRequest()
                .setUnionId("chyxxxxx")
                .setOption(option);
        try {
            client.restoreRecycleItemWithOptions("pQy3Rxxxxx", "recycle_item_id", restoreRecycleItemRequest, restoreRecycleItemHeaders, 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
            }

        }        
    }
}
Python
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys

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()
        restore_recycle_item_headers = dingtalkstorage__1__0_models.RestoreRecycleItemHeaders()
        restore_recycle_item_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.RestoreRecycleItemRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        restore_recycle_item_request = dingtalkstorage__1__0_models.RestoreRecycleItemRequest(
            union_id='chyxxxxx',
            option=option
        )
        try:
            client.restore_recycle_item_with_options('pQy3Rxxxxx', 'recycle_item_id', restore_recycle_item_request, restore_recycle_item_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()
        restore_recycle_item_headers = dingtalkstorage__1__0_models.RestoreRecycleItemHeaders()
        restore_recycle_item_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.RestoreRecycleItemRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        restore_recycle_item_request = dingtalkstorage__1__0_models.RestoreRecycleItemRequest(
            union_id='chyxxxxx',
            option=option
        )
        try:
            await client.restore_recycle_item_with_options_async('pQy3Rxxxxx', 'recycle_item_id', restore_recycle_item_request, restore_recycle_item_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
<?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\RestoreRecycleItemHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RestoreRecycleItemRequest\option;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RestoreRecycleItemRequest;
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();
        $restoreRecycleItemHeaders = new RestoreRecycleItemHeaders([]);
        $restoreRecycleItemHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $option = new option([
            "conflictStrategy" => "AUTO_RENAME"
        ]);
        $restoreRecycleItemRequest = new RestoreRecycleItemRequest([
            "unionId" => "chyxxxxx",
            "option" => $option
        ]);
        try {
            $client->restoreRecycleItemWithOptions("pQy3Rxxxxx", "recycle_item_id", $restoreRecycleItemRequest, $restoreRecycleItemHeaders, 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));
Go
// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "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"
)

/**
 * 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
  }

  restoreRecycleItemHeaders := &dingtalkstorage_1_0.RestoreRecycleItemHeaders{}
  restoreRecycleItemHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  option := &dingtalkstorage_1_0.RestoreRecycleItemRequestOption{
    ConflictStrategy: tea.String("AUTO_RENAME"),
  }
  restoreRecycleItemRequest := &dingtalkstorage_1_0.RestoreRecycleItemRequest{
    UnionId: tea.String("chyxxxxx"),
    Option: option,
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RestoreRecycleItemWithOptions(tea.String("pQy3Rxxxxx"), tea.String("recycle_item_id"), restoreRecycleItemRequest, restoreRecycleItemHeaders, &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)
  }
}
Node.js
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkstorage_1_0, * as $dingtalkstorage_1_0 from '@alicloud/dingtalk/storage_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

  /**
   * Initialize the account Client with a Token
   * @return Client
   * @throws Exception
   */
  static createClient(): dingtalkstorage_1_0 {
    let config = new $OpenApi.Config({ });
    config.protocol = "https";
    config.regionId = "central";
    return new dingtalkstorage_1_0(config);
  }

  static async main(args: string[]): Promise<void> {
    let client = Client.createClient();
    let restoreRecycleItemHeaders = new $dingtalkstorage_1_0.RestoreRecycleItemHeaders({ });
    restoreRecycleItemHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let option = new $dingtalkstorage_1_0.RestoreRecycleItemRequestOption({
      conflictStrategy: "AUTO_RENAME",
    });
    let restoreRecycleItemRequest = new $dingtalkstorage_1_0.RestoreRecycleItemRequest({
      unionId: "chyxxxxx",
      option: option,
    });
    try {
      await client.restoreRecycleItemWithOptions("pQy3Rxxxxx", "recycle_item_id", restoreRecycleItemRequest, restoreRecycleItemHeaders, new $Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.empty(err.code) && !Util.empty(err.message)) {
        // err contains the code and message attributes, which help locate the issue
      }

    }    
  }

}

Client.main(process.argv.slice(2));
C#
// This file is auto-generated, don't edit it. Thanks.

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 
    {

        /**
         * Initialize the account Client with a Token
         * @return Client
         * @throws 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.RestoreRecycleItemHeaders restoreRecycleItemHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemHeaders();
            restoreRecycleItemHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemRequest.RestoreRecycleItemRequestOption option = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemRequest.RestoreRecycleItemRequestOption
            {
                ConflictStrategy = "AUTO_RENAME",
            };
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemRequest restoreRecycleItemRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RestoreRecycleItemRequest
            {
                UnionId = "chyxxxxx",
                Option = option,
            };
            try
            {
                client.RestoreRecycleItemWithOptions("pQy3Rxxxxx", "recycle_item_id", restoreRecycleItemRequest, restoreRecycleItemHeaders, 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
                }
            }
        }

    }
}
python2
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
from __future__ import unicode_literals

import sys

from alibabacloud_dingtalkstorage_1_0.client import Client as dingtalkstorage_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalkstorage_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(object):
    def __init__(self):
        pass

    @staticmethod
    def create_client():
        """
        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):
        client = Sample.create_client()
        restore_recycle_item_headers = dingtalkstorage__1__0_models.RestoreRecycleItemHeaders()
        restore_recycle_item_headers.x_acs_dingtalk_access_token = '<your access token>'
        option = dingtalkstorage__1__0_models.RestoreRecycleItemRequestOption(
            conflict_strategy='AUTO_RENAME'
        )
        restore_recycle_item_request = dingtalkstorage__1__0_models.RestoreRecycleItemRequest(
            union_id='chyxxxxx',
            option=option
        )
        try:
            client.restore_recycle_item_with_options('pQy3Rxxxxx', 'recycle_item_id', restore_recycle_item_request, restore_recycle_item_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:])
Swift
#!/usr/bin/env xcrun swift

import Cocoa
import Foundation
import Tea
import TeaUtils
import AlibabacloudDingtalkstorage10
import AlibabacloudOpenApi

open class Client {
    public static func createClient() throws -> AlibabacloudDingtalkstorage10.Client {
        var config: AlibabacloudOpenApi.Config = AlibabacloudOpenApi.Config([:])
        config.protocol_ = "https"
        config.regionId = "central"
        return AlibabacloudDingtalkstorage10.Client(config)
    }

    @available(macOS 10.15, iOS 13, tvOS 13, watchOS 6, *)
    public static func main(_ args: [String]?) async throws -> Void {
        var client: AlibabacloudDingtalkstorage10.Client = try Client.createClient()
        var restoreRecycleItemHeaders: AlibabacloudDingtalkstorage10.RestoreRecycleItemHeaders = AlibabacloudDingtalkstorage10.RestoreRecycleItemHeaders([:])
        restoreRecycleItemHeaders.xAcsDingtalkAccessToken = "<your access token>"
        var option: AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest.Option = AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest.Option([
            "conflictStrategy": "AUTO_RENAME"
        ])
        var restoreRecycleItemRequest: AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest = AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest([
            "unionId": "chyxxxxx",
            "option": option as! AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest.Option
        ])
        do {
            try await client.restoreRecycleItemWithOptions("pQy3Rxxxxx", "recycle_item_id", restoreRecycleItemRequest as! AlibabacloudDingtalkstorage10.RestoreRecycleItemRequest, restoreRecycleItemHeaders as! AlibabacloudDingtalkstorage10.RestoreRecycleItemHeaders, TeaUtils.RuntimeOptions([:]))
        }
        catch {
            if error is Tea.TeaError {
                var err = error as! Tea.TeaError
                if (!TeaUtils.Client.empty(err.code) && !TeaUtils.Client.empty(err.message)) {
                }
            } else {
                throw error
            }
        }
    }
}

Client.main(CommandLine.arguments)

Response

Response body

NameTypeDescription
asyncBooleanIndicates whether this is an asynchronous task. If the target object has child nodes, the operation is processed asynchronously. - true: Yes. - false: No.
taskIdStringThe ID of the asynchronous task, used to query the task execution status.
spaceIdStringThe space ID of the root node after the restoration. This parameter is returned in both synchronous and asynchronous cases unless the operation fails.
dentryIdStringThe file ID of the root node after the restoration. This parameter is returned in both synchronous and asynchronous cases unless the operation fails.

Response body example

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

{
  "async" : true,
  "taskId" : "task_id",
  "spaceId" : "space_id",
  "dentryId" : "dentry_id"
}

Error codes

If an error occurs when calling this API, refer to the Global error codes document and use the error message to find a solution.
HttpCodeError codeError messageDescription
400paramError%sParameter error.
400paramError.recycleBinId%sParameter error - recycleBinId.
400paramError.recycleItemId%sParameter error - recycleItemId.
400paramError.conflictStrategy%sParameter error - conflictStrategy.
403permissionDenied%sThe user does not have management permissions for the original file or folder of the recycle item.
404recycleBinNotExist%sThe Recycle Bin does not exist.
404recycleItemNotExist%sThe recycle item does not exist.
500systemError%sSystem error.
500unknownErrorUnknown ErrorUnknown error.
503operationTimeout%sRequest timeout.