Skip to main content
Call this API to restore a historical version of a file.

API call description

For example, a file named test.txt is currently at version 5. Call this API to restore the file to version 3. After the call succeeds, the latest version of test.txt becomes 6, and its content is identical to version 3.

Request

Basic information

FieldValue
HTTP URLhttps://api.dingtalk.io/v1.0/storage/spaces/{spaceId}/dentries/{dentryId}/versions/{version}/revert
HTTP MethodPOST
Supported app typesappType-Internal app appType-Third-party enterprise app
Required permissionspermission-Storage.File.Write-Write permission for organization storage files

request header

NameTypeRequiredDescription
x-acs-dingtalk-access-tokenStringYesThe 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 authorized enterprise for a third-party app API.

path parameter

NameTypeRequiredDescription
spaceIdStringYesThe space ID. Call the Add space API to obtain the value of the id parameter.
dentryIdStringYesThe file ID. 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.
versionLongYesThe version number of the file to restore. The minimum value is 0.

query parameter

NameTypeRequiredDescription
unionIdStringYesThe unionId of the operator. Call the Query user details API to obtain the value of the unionid parameter.

Request example

HTTP
POST /v1.0/storage/spaces/854xxxxx/dentries/655xxxxx/versions/1/revert?unionId=chyxxxxx HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

{ }
Java
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * <b>description</b> :
     * <p>Initialize the account Client using 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.RevertDentryVersionHeaders revertDentryVersionHeaders = new com.aliyun.dingtalkstorage_1_0.models.RevertDentryVersionHeaders();
        revertDentryVersionHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkstorage_1_0.models.RevertDentryVersionRequest revertDentryVersionRequest = new com.aliyun.dingtalkstorage_1_0.models.RevertDentryVersionRequest()
                .setUnionId("chyxxxxx");
        try {
            client.revertDentryVersionWithOptions("854xxxxx", "655xxxxx", "1", revertDentryVersionRequest, revertDentryVersionHeaders, 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 can help developers 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 can help developers locate the issue
            }

        }        
    }
}
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:
        """
        Initialize the account Client using 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()
        revert_dentry_version_headers = dingtalkstorage__1__0_models.RevertDentryVersionHeaders()
        revert_dentry_version_headers.x_acs_dingtalk_access_token = '<your access token>'
        revert_dentry_version_request = dingtalkstorage__1__0_models.RevertDentryVersionRequest(
            union_id='chyxxxxx'
        )
        try:
            client.revert_dentry_version_with_options('854xxxxx', '655xxxxx', '1', revert_dentry_version_request, revert_dentry_version_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 can help developers locate the issue
                pass

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        revert_dentry_version_headers = dingtalkstorage__1__0_models.RevertDentryVersionHeaders()
        revert_dentry_version_headers.x_acs_dingtalk_access_token = '<your access token>'
        revert_dentry_version_request = dingtalkstorage__1__0_models.RevertDentryVersionRequest(
            union_id='chyxxxxx'
        )
        try:
            await client.revert_dentry_version_with_options_async('854xxxxx', '655xxxxx', '1', revert_dentry_version_request, revert_dentry_version_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 can help developers 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\RevertDentryVersionHeaders;
use AlibabaCloud\SDK\Dingtalk\Vstorage_1_0\Models\RevertDentryVersionRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * Initialize the account Client using 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();
        $revertDentryVersionHeaders = new RevertDentryVersionHeaders([]);
        $revertDentryVersionHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $revertDentryVersionRequest = new RevertDentryVersionRequest([
            "unionId" => "chyxxxxx"
        ]);
        try {
            $client->revertDentryVersionWithOptions("854xxxxx", "655xxxxx", "1", $revertDentryVersionRequest, $revertDentryVersionHeaders, 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 can help developers 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
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 using 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
  }

  revertDentryVersionHeaders := &dingtalkstorage_1_0.RevertDentryVersionHeaders{}
  revertDentryVersionHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  revertDentryVersionRequest := &dingtalkstorage_1_0.RevertDentryVersionRequest{
    UnionId: tea.String("chyxxxxx"),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.RevertDentryVersionWithOptions(tea.String("854xxxxx"), tea.String("655xxxxx"), tea.String("1"), revertDentryVersionRequest, revertDentryVersionHeaders, &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 can help developers locate the issue
    }

  }
  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 {

  /**
   * Initialize the account Client using 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 revertDentryVersionHeaders = new dingtalkstorage_1_0.RevertDentryVersionHeaders({ });
    revertDentryVersionHeaders.xAcsDingtalkAccessToken = '<your access token>';
    let revertDentryVersionRequest = new dingtalkstorage_1_0.RevertDentryVersionRequest({
      unionId: 'chyxxxxx',
    });
    try {
      await client.revertDentryVersionWithOptions('854xxxxx', '655xxxxx', '1', revertDentryVersionRequest, revertDentryVersionHeaders, new Util.RuntimeOptions({ }));
    } catch (err) {
      if (!Util.default.empty(err.code) && !Util.default.empty(err.message)) {
        // err contains the code and message attributes, which can help developers locate the issue
      }

    }    
  }

}

exports.Client = Client;
Client.main(process.argv.slice(2));
C#
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 using 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.RevertDentryVersionHeaders revertDentryVersionHeaders = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RevertDentryVersionHeaders();
            revertDentryVersionHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RevertDentryVersionRequest revertDentryVersionRequest = new AlibabaCloud.SDK.Dingtalkstorage_1_0.Models.RevertDentryVersionRequest
            {
                UnionId = "chyxxxxx",
            };
            try
            {
                client.RevertDentryVersionWithOptions("854xxxxx", "655xxxxx", "1", revertDentryVersionRequest, revertDentryVersionHeaders, 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 can help developers 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 can help developers locate the issue
                }
            }
        }

    }
}

Response

response body

NameTypeDescription
successBooleanWhether the operation 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, refer to the Global error codes document to find a solution based on the error message.
HttpCodeError codeError messageDescription
400operationConcurrentControl%sConcurrency control
400paramError%sParameter error
403permissionDenied%sThe user lacks the permission to retrieve file or folder information
500systemError%sSystem error
500unknownErrorUnknown ErrorUnknown error
503operationTimeout%sRequest timed out