Working with File Api Leave feedback

This API allows you to download a file from GroupDocs Cloud Storage.

API Explorer

GroupDocs.Comparison Cloud API Reference lets you to try out Download a File API right away in your browser! It allows you to effortlessly interact and try out every single operation our APIs exposes.

Request parameters

Parameter	Description
Path	Path of the file including file name and extension e.g. /Folder1/file.ext Required. Can be passed as query string parameter or as part of the URL
storageName	Name of the storage. If not set, then default storage used
versionId	File version id

cURL example

Request

curl -X GET "https://api.groupdocs.cloud/v2.0/comparison/storage/file/one-page.docx?storageName#MyStorage" -H  "accept: multipart/form-data" -H  "authorization: Bearer [Access Token]"

Response

{
  "Code": 200,
  "Status": "OK"
}

SDK example

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the File API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

using GroupDocs.Comparison.Cloud.Sdk.Api;
using GroupDocs.Comparison.Cloud.Sdk.Client;
using GroupDocs.Comparison.Cloud.Sdk.Model.Requests;
using System;

namespace GroupDocs.Comparison.Cloud.Examples.CSharp
{
	// Download_File
	class Download_File
	{
		public static void Run()
		{
			var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
			var apiInstance = new FileApi(configuration);

			try
			{
				var request = new DownloadFileRequest("Comparisondocs/one-page.docx", Common.MyStorage);

				var response = apiInstance.DownloadFile(request);
				Console.WriteLine("Expected response type is Stream: " + response.Length.ToString());
			}
			catch (Exception e)
			{
				Console.WriteLine("Exception while calling FileApi: " + e.Message);
			}
		}
	}
}

Java

package examples.Working_With_Files;

import java.io.File;
import com.groupdocs.cloud.comparison.api.*;
import com.groupdocs.cloud.comparison.client.ApiException;
import com.groupdocs.cloud.comparison.model.requests.*;
import examples.Utils;

public class Comparison_Java_Download_File {

	public static void main(String[] args) {

		FileApi apiInstance = new FileApi(Utils.AppSID, Utils.AppKey);
		try {

			DownloadFileRequest request = new DownloadFileRequest("Comparisondocs\\one-page.docx", Utils.MYStorage, null);
			File response = apiInstance.downloadFile(request);
			System.err.println("Expected response type is File: " + response.length());
		} catch (ApiException e) {
			System.err.println("Exception while calling FileApi:");
			e.printStackTrace();
		}
	}
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

	try {
		$apiInstance = CommonUtils::GetFileApiInstance();

		$request = new GroupDocs\Comparison\Model\Requests\DownloadFileRequest("comparisondocs\one-page.docx", CommonUtils::$MyStorage, null);
		$response = $apiInstance->downloadFile($request);
		
		echo "Expected response type is File: ", strlen($response);
	} catch (Exception $e) {
		echo "Something went wrong: ", $e->getMessage(), "\n";
	}
?>

Node.js

"use strict";
class Comparison_Node_Download_File {
	static Run() {
		var request = new groupdocs_comparison_cloud_1.DownloadFileRequest("Comparisondocs/one-page.docx", myStorage);
		fileApi.downloadFile(request)
			.then(function (response) {
				console.log("Expected response type is Stream: " + response.length);
			})
			.catch(function (error) {
				console.log("Error: " + error.message);
			});
	}
}
module.exports = Comparison_Node_Download_File;

Python

# Import modules
import groupdocs_comparison_cloud

from Common_Utilities.Utils import Common_Utilities


class Comparison_Python_Download_File:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_FileApi_Instance()
        
        try:
            request = groupdocs_comparison_cloud.DownloadFileRequest("comparisondocs\\source.docx", Common_Utilities.myStorage)
            response = api.download_file(request)
            
            print("Expected response type is Stream: " + str(len(response)))
        except groupdocs_comparison_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

Ruby

# Load the gem
require 'groupdocs_comparison_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Files
  def self.Comparison_Ruby_Download_File()

    # Getting instance of the API
    $api = Common_Utilities.Get_FileApi_Instance()

    $request = GroupDocsComparisonCloud::DownloadFileRequest.new("comparisondocs/one-page.docx", $myStorage)
    $response = $api.download_file($request)
    
    puts("Expected response type is Stream: " + ($response).to_s)
  end
end

Apex


Configuration configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
FileApi apiInstance = new FileApi(configuration);

DownloadFileRequest request = new DownloadFileRequest();
request.Path = 'Comparisondocs/one-page.docx';

Stream response = apiInstance.downloadFile(request);
System.debug('Expected response type is Stream. Length: ' + response.getBytes().size());

Upload File API

This API allows you to upload files to the GroupDocs Cloud Storage.

API Explorer

GroupDocs.Comparison Cloud API Reference lets you try out Upload a File API right away in your browser! It allows you to effortlessly interact and try out every single operation our APIs exposes.

Request Body parameters

Parameter	Description
path	Path of the file including file name and extension e.g. /Folder1/file.ext Required. Can be passed as query string parameter or as part of the URL
storageName	Name of the storage. If not set, then default storage used
File	File content

cURL example

Request

curl -X POST "https://api.groupdocs.cloud/v2.0/comparison/storage/file/comparisondocs%2Fone-page2.docx?storageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

Http status code: 200 (Returns OK and list of errors, which is empty if success.)
{
  "Uploaded": [
    "string"
  ],
  "Errors": [
    {
      "Code": "string",
      "Message": "string",
      "Description": "string",
      "InnerError": {
        "RequestId": "string",
        "Date": "2019-02-27T06:10:08.884Z"
      }
    }
  ]
}

SDK example

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the File API calls and lets you use GroupDocs for Cloud features in a native way for your preferred language.

using System;
using System.IO;
using GroupDocs.Comparison.Cloud.Sdk.Api;
using GroupDocs.Comparison.Cloud.Sdk.Client;
using GroupDocs.Comparison.Cloud.Sdk.Model.Requests;

namespace GroupDocs.Comparison.Cloud.Examples.CSharp
{
	// Upload File
	class Upload_File
	{
		public static void Run()
		{
			var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
			var apiInstance = new FileApi(configuration);

			try
			{
				// Open file in IOStream from local/disc.
				var fileStream = File.Open("..\\..\\..\\Data\\Comparisondocs\\one-page.docx", FileMode.Open);

				var request = new UploadFileRequest("Comparisondocs/one-page1.docx", fileStream, Common.MyStorage);

				var response = apiInstance.UploadFile(request);
				Console.WriteLine("Expected response type is FilesUploadResult: " + response.Uploaded.Count.ToString());
			}
			catch (Exception e)
			{
				Console.WriteLine("Exception while calling FileApi: " + e.Message);
			}
		}
	}
}

Java

package examples.Working_With_Files;

import java.io.File;
import java.nio.file.Paths;

import com.groupdocs.cloud.comparison.api.*;
import com.groupdocs.cloud.comparison.client.ApiException;
import com.groupdocs.cloud.comparison.model.*;
import com.groupdocs.cloud.comparison.model.requests.*;
import examples.Utils;

public class Comparison_Java_Upload_File {

	public static void main(String[] args) {

		FileApi apiInstance = new FileApi(Utils.AppSID, Utils.AppKey);
		try {
			File fileStream = new File(
					Paths.get("src\\main\\resources").toAbsolutePath().toString() + "\\Comparisondocs\\one-page.docx");
			UploadFileRequest request = new UploadFileRequest("Comparisondocs\\one-page1.docx", fileStream,
					Utils.MYStorage);
			FilesUploadResult response = apiInstance.uploadFile(request);
			System.out.println("Expected response type is FilesUploadResult: " + response.getUploaded().size());
		} catch (ApiException e) {
			System.err.println("Exception while calling FileApi:");
			e.printStackTrace();
		}
	}
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

	try {
		$apiInstance = CommonUtils::GetFileApiInstance();
		$filePath = realpath(dirname(__DIR__). '\Resources\comparisondocs\one-page.docx');
		echo "filePath: ". $filePath;

		$fileStream = readfile($filePath);
		$request = new GroupDocs\Comparison\Model\Requests\UploadFileRequest("comparisondocs\one-page1.docx", $fileStream);
		$response = $apiInstance->uploadFile($request);
		
		echo "Expected response type is FilesUploadResult: ", $response;
	} catch (Exception $e) {
		echo "Something went wrong: ", $e->getMessage(), "\n";
	}
?>

Node.js

"use strict";
class Comparison_Node_Upload_File {
	static Run() {

		// Open file in IOStream from local/disc.
		var resourcesFolder = './Resources/Comparisondocs/one-page.docx';
		fs.readFile(resourcesFolder, (err, fileStream) => {

			var request = new groupdocs_comparison_cloud_1.UploadFileRequest("Comparisondocs/one-page1.docx", fileStream, myStorage);
			fileApi.uploadFile(request)
				.then(function (response) {
					console.log("Expected response type is FilesUploadResult: " + response.uploaded.length);
				})
				.catch(function (error) {
					console.log("Error: " + error.message);
				});
		});
	}
}
module.exports = Comparison_Node_Upload_File;

Python

# Import modules
import groupdocs_comparison_cloud

from Common_Utilities.Utils import Common_Utilities


class Comparison_Python_Upload_File:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_FileApi_Instance()
        
        try:
            request = groupdocs_comparison_cloud.UploadFileRequest("comparisondocs\\source.docx", "D:\\ewspace\\GroupDocs.Comparison.Cloud.Python.Examples\\src\\Resources\\comparisondocs\\source.docx", Common_Utilities.myStorage)
            response = api.upload_file(request)
            
            print("Expected response type is FilesUploadResult: " + str(response))
        except groupdocs_comparison_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

Ruby

# Load the gem
require 'groupdocs_comparison_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Files
  def self.Comparison_Ruby_Upload_File()

    # Getting instance of the API
    $api = Common_Utilities.Get_FileApi_Instance()

    $fileStream = File.new("src\\Resources\\comparisondocs\\source.docx", "r")

    $request = GroupDocsComparisonCloud::UploadFileRequest.new("comparisondocs/source1.docx", $fileStream, $myStorage)
    $response = $api.upload_file($request)

    $fileStream.close()

    puts("Expected response type is FilesUploadResult: " + ($response).to_s)
  end
end

Apex

// Create config and API instances
Configuration config = new Configuration('YOUR_API_KEY', 'YOUR_API_SECRET'); // Replace with your credentials
FileApi fileApi = new FileApi(config);

try {
    // Fetch the file content from Salesforce
    List<ContentVersion> contentVersions = [SELECT Id, Title, VersionData 
                                             FROM ContentVersion 
                                             WHERE Title = 'one-page.docx' 
                                             LIMIT 1];
    if (contentVersions.isEmpty()) {
        throw new Exception('File one-page.docx not found in ContentVersion.');
    }

    // Prepare the upload request
    UploadFileRequest uploadRequest = new UploadFileRequest('Comparisondocs/one-page1.docx', contentVersions[0].VersionData, null);

    // Upload the file
    FilesUploadResult response = fileApi.uploadFile(uploadRequest);

    // Log the result
    System.debug('Expected response type is FilesUploadResult: ' + response.Uploaded.size());
} catch (Exception e) {
    System.debug('Exception while calling FileApi: ' + e.getMessage());
}

Delete File API

This API allows you to delete specific file from GroupDocs Cloud Storage.

API Explorer

GroupDocs.Comparison Cloud API Reference lets you to try out Delete a File right away in your browser! It allows you to effortlessly interact and try out every single operation our APIs exposes.

Request parameters

Parameter	Description
path	Path of the file including file name and extension e.g. /Folder1/file.ext Required. Can be passed as query string parameter or as part of the URL
storageName	Name of the storage. If not set, then default storage used
versionId	File version id

cURL example

Request

curl -X DELETE "https://api.groupdocs.cloud/v2.0/comparison/storage/file/comparisondocs%2Fone-page1.docx?storageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{
  "Code": 200,
  "Status": "OK"
}

SDK example

using GroupDocs.Comparison.Cloud.Sdk.Api;
using GroupDocs.Comparison.Cloud.Sdk.Client;
using GroupDocs.Comparison.Cloud.Sdk.Model.Requests;
using System;

namespace GroupDocs.Comparison.Cloud.Examples.CSharp
{
	// Delete File
	class Delete_File
	{
		public static void Run()
		{
			var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
			var apiInstance = new FileApi(configuration);

			try
			{
				var request = new DeleteFileRequest("Comparisondocs1/one-page1.docx", Common.MyStorage);

				apiInstance.DeleteFile(request);
				Console.WriteLine("Expected response type is Void: 'Comparisondocs1/one-page1.docx' deleted.");
			}
			catch (Exception e)
			{
				Console.WriteLine("Exception while calling FileApi: " + e.Message);
			}
		}
	}
}

Java

package examples.Working_With_Files;

import com.groupdocs.cloud.comparison.api.*;
import com.groupdocs.cloud.comparison.client.ApiException;
import com.groupdocs.cloud.comparison.model.requests.*;
import examples.Utils;

public class Comparison_Java_Delete_File {

	public static void main(String[] args) {

		FileApi apiInstance = new FileApi(Utils.AppSID, Utils.AppKey);
		try {

			DeleteFileRequest request = new DeleteFileRequest("Comparisondocs1\\one-page1.docx", Utils.MYStorage, null);
			apiInstance.deleteFile(request);
			System.out.println("Expected response type is Void: 'Comparisondocs1/one-page1.docx' deleted.");
		} catch (ApiException e) {
			System.err.println("Exception while calling FileApi:");
			e.printStackTrace();
		}
	}
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

	try {
		$apiInstance = CommonUtils::GetFileApiInstance();

		$request = new GroupDocs\Comparison\Model\Requests\DeleteFileRequest("comparisondocs\one-page-copied.docx", CommonUtils::$MyStorage);
		$apiInstance->deleteFile($request);
		
		echo "Expected response type is Void: 'comparisondocs1/one-page-copied.docx' file deleted.";
	} catch (Exception $e) {
		echo "Something went wrong: ", $e->getMessage(), "\n";
	}
?>

Node.js

"use strict";
class Comparison_Node_Delete_File {
	static Run() {
		var request = new groupdocs_comparison_cloud_1.DeleteFileRequest("Comparisondocs1/one-page1.docx", myStorage);
		fileApi.deleteFile(request)
			.then(function (response) {
				console.log("Expected response type is Void: 'Comparisondocs1/one-page1.docx' deleted.");
			})
			.catch(function (error) {
				console.log("Error: " + error.message);
			});
	}
}
module.exports = Comparison_Node_Delete_File;

Python

# Import modules
import groupdocs_comparison_cloud

from Common_Utilities.Utils import Common_Utilities


class Comparison_Python_Delete_File:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_FileApi_Instance()
        
        try:
            request = groupdocs_comparison_cloud.DeleteFileRequest("comparisondocs1\\source.docx", Common_Utilities.myStorage)
            api.delete_file(request)
            
            print("Expected response type is Void: 'comparisondocs1/source.docx' deleted.")
        except groupdocs_comparison_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

Ruby

# Load the gem
require 'groupdocs_comparison_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Files
  def self.Comparison_Ruby_Delete_File()

    # Getting instance of the API
    $api = Common_Utilities.Get_FileApi_Instance()

    $request = GroupDocsComparisonCloud::DeleteFileRequest.new("comparisondocs1/source.docx", $myStorage)
    $response = $api.delete_file($request)

    puts("Expected response type is Void: 'comparisondocs1/one-page.docx' deleted.")
  end
end

Apex

// Create config and API instances
Configuration config = new Configuration('YOUR_API_KEY', 'YOUR_API_SECRET'); // Replace with your credentials
FileApi fileApi = new FileApi(config);

try {
    // Prepare the delete file request
    DeleteFileRequest deleteRequest = new DeleteFileRequest('Comparisondocs1/one-page1.docx', null);

    // Delete the file
    fileApi.deleteFile(deleteRequest);

    // Log success message
    System.debug('Expected response type is Void: \'Comparisondocs1/one-page1.docx\' deleted.');
} catch (Exception e) {
    System.debug('Exception while calling FileApi: ' + e.getMessage());
}

File Copy API

This API allows you to copy specific file from GroupDocs Cloud Storage.

API Explorer

GroupDocs.Comparison Cloud API Reference lets you to try out Copy File right away in your browser! It allows you to effortlessly interact and try out every single operation our APIs exposes.

Request parameters

Parameter	Description
srcPath	Path of the source file including file name and extension e.g. /Folder1/file.ext Required. Can be passed as query string parameter or as part of the URL
destPath	Path of the destination file. Required.
srcStorageName	Name of the storage of source file. If not set, then default storage used
destStorageName	Name of the storage of destination file. If not set, then default storage used
versionId	Source file version id

cURL example

Request

curl -X PUT "https://api.groupdocs.cloud/v2.0/comparison/storage/file/copy/comparisondocs%2Fone-page1.docx?destPath#comparisondocs%2Fone-page1.docx'&#x26;srcStorageName#MyStorage&#x26;destStorageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{
  "Code": 200,
  "Status": "OK"
}

SDK example

using GroupDocs.Comparison.Cloud.Sdk.Api;
using GroupDocs.Comparison.Cloud.Sdk.Client;
using GroupDocs.Comparison.Cloud.Sdk.Model.Requests;
using System;

namespace GroupDocs.Comparison.Cloud.Examples.CSharp
{
	// Copy File
	class Copy_File
	{
		public static void Run()
		{
			var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
			var apiInstance = new FileApi(configuration);

			try
			{
				var request = new CopyFileRequest("Comparisondocs/one-page1.docx", "Comparisondocs/one-page-copied.docx", Common.MyStorage, Common.MyStorage);

				apiInstance.CopyFile(request);
				Console.WriteLine("Expected response type is Void: 'Comparisondocs/one-page1.docx' file copied as 'Comparisondocs/one-page-copied.docx'.");
			}
			catch (Exception e)
			{
				Console.WriteLine("Exception while calling FileApi: " + e.Message);
			}
		}
	}
}

Java

package examples.Working_With_Files;

import com.groupdocs.cloud.comparison.api.*;
import com.groupdocs.cloud.comparison.client.ApiException;
import com.groupdocs.cloud.comparison.model.requests.*;
import examples.Utils;

public class Comparison_Java_Copy_File {

	public static void main(String[] args) {

		FileApi apiInstance = new FileApi(Utils.AppSID, Utils.AppKey);
		try {

			CopyFileRequest request = new CopyFileRequest("Comparisondocs\\one-page.docx",
					"Comparisondocs\\one-page-copied.docx", Utils.MYStorage, Utils.MYStorage, null);
			apiInstance.copyFile(request);
			System.out.println(
					"Expected response type is Void: 'Comparisondocs/one-page1.docx' file copied as 'Comparisondocs/one-page-copied.docx'.");
		} catch (ApiException e) {
			System.err.println("Exception while calling FileApi:");
			e.printStackTrace();
		}
	}
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

	try {
		$apiInstance = CommonUtils::GetFileApiInstance();

		$request = new GroupDocs\Comparison\Model\Requests\CopyFileRequest("comparisondocs\one-page.docx", "comparisondocs\one-page-copied.docx", CommonUtils::$MyStorage, CommonUtils::$MyStorage);
		$apiInstance->copyFile($request);
		
		echo "Expected response type is Void: 'comparisondocs/one-page.docx' file copied as 'comparisondocs/one-page-copied.docx'.";
	} catch (Exception $e) {
		echo "Something went wrong: ", $e->getMessage(), "\n";
	}
?>

Node.js

"use strict";
class Comparison_Node_Copy_File {
	static Run() {
		var request = new groupdocs_comparison_cloud_1.CopyFileRequest("Comparisondocs/one-page1.docx", "Comparisondocs/one-page-copied.docx", myStorage, myStorage);
		fileApi.copyFile(request)
			.then(function (response) {
				console.log("Expected response type is Void: 'Comparisondocs/one-page1.docx' file copied as 'Comparisondocs/one-page-copied.docx'.");
			})
			.catch(function (error) {
				console.log("Error: " + error.message);
			});
	}
}
module.exports = Comparison_Node_Copy_File;

Python

# Import modules
import groupdocs_comparison_cloud

from Common_Utilities.Utils import Common_Utilities


class Comparison_Python_Copy_File:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_FileApi_Instance()
        
        try:
            request = groupdocs_comparison_cloud.CopyFileRequest("comparisondocs\\source.docx", "comparisondocs\\source-copied.docx", Common_Utilities.myStorage, Common_Utilities.myStorage)
            api.copy_file(request)
            
            print("Expected response type is Void: 'comparisondocs/source.docx' file copied as 'comparisondocs/source-copied.docx'.")
        except groupdocs_comparison_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

Ruby

# Load the gem
require 'groupdocs_comparison_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Files
  def self.Comparison_Ruby_Copy_File()

    # Getting instance of the API
    $api = Common_Utilities.Get_FileApi_Instance()

    $request = GroupDocsComparisonCloud::CopyFileRequest.new("source.docx", "comparisondocs\\source.docx", $myStorage, $myStorage)
    $response = $api.copy_file($request)

    puts("Expected response type is Void: 'comparisondocs/source.docx' file copied as 'comparisondocs/source-copied.docx'.")
  end
end

Apex

// Create config and API instances
Configuration config = new Configuration('YOUR_API_KEY', 'YOUR_API_SECRET'); // Replace with your credentials
FileApi fileApi = new FileApi(config);

try {
    // Prepare the copy file request
    CopyFileRequest copyRequest = new CopyFileRequest('Comparisondocs/one-page1.docx', 'Comparisondocs/one-page-copied.docx', null, null);

    // Copy the file
    fileApi.copyFile(copyRequest);

    // Log success message
    System.debug('Expected response type is Void: \'Comparisondocs/one-page1.docx\' file copied as \'Comparisondocs/one-page-copied.docx\'.');
} catch (Exception e) {
    System.debug('Exception while calling FileApi: ' + e.getMessage());
}

File Move API

This API allows you to copy specific file from GroupDocs Cloud Storage.

API Explorer

GroupDocs.Comparison Cloud API Reference lets you to try out Move File right away in your browser! It allows you to effortlessly interact and try out every single operation our APIs exposes.

Request parameters

Parameter	Description
srcPath	Path of the source file including file name and extension e.g. /Folder1/file.ext Required. Can be passed as query string parameter or as part of the URL
destPath	Path of the destination file. Required.
srcStorageName	Name of the storage of source file. If not set, then default storage used
destStorageName	Name of the storage of destination file. If not set, then default storage used
versionId	Source file version id

cURL example

Request

curl -X PUT "https://api.groupdocs.cloud/v2.0/comparison/storage/file/move/comparisondocs%2Fone-page1.docx?destPath#comparisondocs%2Fone-page1.docx'&#x26;srcStorageName#MyStorage&#x26;destStorageName#MyStorage" -H  "accept: application/json" -H  "authorization: Bearer [Access Token]"

Response

{
  "Code": 200,
  "Status": "OK"
}

SDK example

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it hides the File API calls and lets you use GroupDocs for Cloud features in a native way for your preferred language.

using GroupDocs.Comparison.Cloud.Sdk.Api;
using GroupDocs.Comparison.Cloud.Sdk.Client;
using GroupDocs.Comparison.Cloud.Sdk.Model.Requests;
using System;

namespace GroupDocs.Comparison.Cloud.Examples.CSharp
{
	// Move File
	class Move_File
	{
		public static void Run()
		{
			var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
			var apiInstance = new FileApi(configuration);

			try
			{
				var request = new MoveFileRequest("Comparisondocs/one-page1.docx", "Comparisondocs1/one-page1.docx", Common.MyStorage, Common.MyStorage);

				apiInstance.MoveFile(request);
				Console.WriteLine("Expected response type is Void: 'Comparisondocs/one-page1.docx' file moved to 'Comparisondocs1/one-page1.docx'.");
			}
			catch (Exception e)
			{
				Console.WriteLine("Exception while calling FileApi: " + e.Message);
			}
		}
	}
}

Java

package examples.Working_With_Files;

import com.groupdocs.cloud.comparison.api.*;
import com.groupdocs.cloud.comparison.client.ApiException;
import com.groupdocs.cloud.comparison.model.requests.*;
import examples.Utils;

public class Comparison_Java_Move_File {

	public static void main(String[] args) {

		FileApi apiInstance = new FileApi(Utils.AppSID, Utils.AppKey);
		try {

			MoveFileRequest request = new MoveFileRequest("Comparisondocs\\one-page1.docx", "Comparisondocs1\\one-page1.docx",
					Utils.MYStorage, Utils.MYStorage, null);
			apiInstance.moveFile(request);
			System.out.println(
					"Expected response type is Void: 'Comparisondocs/one-page1.docx' file moved to 'Comparisondocs1/one-page1.docx'.");
		} catch (ApiException e) {
			System.err.println("Exception while calling FileApi:");
			e.printStackTrace();
		}
	}
}

PHP

<?php

include(dirname(__DIR__) . '\CommonUtils.php');

	try {
		$apiInstance = CommonUtils::GetFileApiInstance();

		$request = new GroupDocs\Comparison\Model\Requests\MoveFileRequest("comparisondocs\one-page.docx", "comparisondocs1\one-page-copied.docx", CommonUtils::$MyStorage, CommonUtils::$MyStorage);
		$apiInstance->moveFile($request);
		
		echo "Expected response type is Void: 'comparisondocs/one-page.docx' file moved as 'comparisondocs1/one-page-copied.docx'.";
	} catch (Exception $e) {
		echo "Something went wrong: ", $e->getMessage(), "\n";
	}
?>

Node.js

"use strict";
class Comparison_Node_Move_File {
	static Run() {
		var request = new groupdocs_comparison_cloud_1.MoveFileRequest("Comparisondocs/one-page1.docx", "Comparisondocs1/one-page1.docx", myStorage, myStorage);
		fileApi.moveFile(request)
			.then(function (response) {
				console.log("Expected response type is Void: 'Comparisondocs/one-page1.docx' file moved to 'Comparisondocs1/one-page1.docx'.");
			})
			.catch(function (error) {
				console.log("Error: " + error.message);
			});
	}
}
module.exports = Comparison_Node_Move_File;

Python

# Import modules
import groupdocs_comparison_cloud

from Common_Utilities.Utils import Common_Utilities


class Comparison_Python_Move_File:
    
    @classmethod
    def Run(self):
        # Create instance of the API
        api = Common_Utilities.Get_FileApi_Instance()
        
        try:
            request = groupdocs_comparison_cloud.MoveFileRequest("comparisondocs\\source.docx", "comparisondocs1\\source.docx", Common_Utilities.myStorage, Common_Utilities.myStorage)
            api.move_file(request)
            
            print("Expected response type is Void: 'comparisondocs/source.docx' file moved to 'comparisondocs1/source.docx'.")
        except groupdocs_comparison_cloud.ApiException as e:
            print("Exception while calling API: {0}".format(e.message))

Ruby

# Load the gem
require 'groupdocs_comparison_cloud'
require 'common_utilities/Utils.rb'

class Working_With_Files
  def self.Comparison_Ruby_Move_File()

    # Getting instance of the API
    $api = Common_Utilities.Get_FileApi_Instance()

    $request = GroupDocsComparisonCloud::MoveFileRequest.new("comparisondocs/source.docx", "comparisondocs1/source.docx", $myStorage, $myStorage)
    $response = $api.move_file($request)

    puts("Expected response type is Void: 'comparisondocs/source.docx' file moved to 'comparisondocs1/source.docx'.")
  end
end

Apex

// Create config and API instances
Configuration config = new Configuration('YOUR_API_KEY', 'YOUR_API_SECRET'); // Replace with your credentials
FileApi fileApi = new FileApi(config);

try {
    // Prepare the move file request
    MoveFileRequest moveRequest = new MoveFileRequest('Comparisondocs/one-page1.docx', 'Comparisondocs1/one-page1.docx', null, null);

    // Move the file
    fileApi.moveFile(moveRequest);

    // Log success message
    System.debug('Expected response type is Void: \'Comparisondocs/one-page1.docx\' file moved to \'Comparisondocs1/one-page1.docx\'.');
} catch (Exception e) {
    System.debug('Exception while calling FileApi: ' + e.getMessage());
}

We value your opinion. Your feedback will help us improve our documentation.

Working with File Api Leave feedback

On this page

API Explorer

Request parameters

cURL example

SDK example

Upload File API

API Explorer

Request Body parameters

cURL example

SDK example

Delete File API

API Explorer

Request parameters

cURL example

SDK example

File Copy API

API Explorer

Request parameters

cURL example

SDK example

File Move API

API Explorer

Request parameters

cURL example

SDK example

Was this page helpful?

Any additional feedback you'd like to share with us?

Please tell us how we can improve this page.

Thank you for your feedback!

On this page