Excel worksheet rename

This REST API indicates worksheet rename

RSET API

 
POST http://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/rename

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path
sheetName	string	path
newname	string	query
folder	string	query
storageName	string	query	storage name.

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to make calls to Cloud API with cURL.

Request

 
curl -v "http://api.aspose.com/v3.0/cells/Sample_Test_Book.xls/worksheets/Sheet1/rename?newname=newSheet" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

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

Cloud SDK Family

Using an SDK is the best way to speed up the development. An SDK takes care of low-level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to make calls to Aspose.Cells web services using various SDKs:

	// For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-dotnet/
	namespace Aspose.Cells.Cloud.SDK.Example
	{
	using Aspose.Cells.Cloud.SDK.Api;
	using Aspose.Cells.Cloud.SDK.Request;
	using System;

	public partial class CellsApiExample
	{
	public void PostRenameWorksheetExample()
	{
	CellsApi cellsApi = new CellsApi(Environment.GetEnvironmentVariable("CellsCloudTestClientId"), Environment.GetEnvironmentVariable("CellsCloudTestClientSecret"));
	PostRenameWorksheetRequest request = new PostRenameWorksheetRequest { name = "Book1.xlsx", sheetName = "Sheet1", newname="newSheet", folder = "TestData/In" };
	cellsApi.PostRenameWorksheet(request);
	}
	}
	}
	// Obsolete
	//CellsWorksheetsApi instance = new CellsWorksheetsApi(GetConfiguration());
	//string name = "Book1.xlsx";
	//string sheetName = "Sheet1";
	//string newname = "renametest";
	//string folder = null;
	//UpdateDataFile(folder, name);
	//var response = instance.CellsWorksheetsPostRenameWorksheet(name, sheetName, newname, folder);

view raw Examples-.NET-CellsWorksheetsPostRenameWorksheet.cs hosted with ❤ by GitHub

Java

View raw

(Sorry about that, but we can’t show files that are this big right now.)

view raw Examples-Java-worksheet-RenameWorksheet-rename-excel-worksheeet.java hosted with ❤ by GitHub

PHP

	<?php
	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-php
	require_once('vendor\autoload.php');
	use \Aspose\Cells\Cloud\Api\CellsApi;
	use \Aspose\Cells\Cloud\Request\PostRenameWorksheetRequest;

	class Worksheet {

	public $instance;

	public function __construct() {
	$this->instance = new CellsApi(getenv("CellsCloudClientId"),getenv("CellsCloudClientSecret"),"v3.0",getenv("CellsCloudApiBaseUrl"));
	}

	public function postRenameWorksheet() {
	$remoteFolder = "TestData/In";
	$localName = "Book1.xlsx";
	$remoteName = "Book1.xlsx";
	$request = new PostRenameWorksheetRequest();
	$request->setName( $remoteName);
	$request->setSheetName( "Sheet5");
	$request->setNewname( "Sheet55");
	$request->setFolder( $remoteFolder);
	$request->setStorageName( "");
	$this->instance->postRenameWorksheet($request);
	}
	}

	$worksheet = new Worksheet();
	$worksheet->postRenameWorksheet();

	?>

view raw Examples-PHP-Worksheet-PostRenameWorksheet-.php hosted with ❤ by GitHub

Ruby

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-ruby
	require 'aspose_cells_cloud'

	class Worksheet

	include AsposeCellsCloud

	def initialize
	@instance = AsposeCellsCloud::CellsApi.new($client_id,$client_secret,$api_version,$baseurl)
	end

	# Rename worksheet
	def rename_worksheet
	name = $BOOK1
	sheet_name = $SHEET1
	newname = 'renametest'
	folder = $TEMPFOLDER
	result = @instance.upload_file( folder+"/"+name, ::File.open(File.expand_path("data/"+name),"r") {\|io\| io.read(io.size) })
	expect(result.uploaded.size).to be > 0
	result = @instance.cells_worksheets_post_rename_worksheet(name, sheet_name, newname, { :folder=>folder})
	expect(result.code).to eql(200)
	end

	end

	worksheet = Worksheet.new()
	puts worksheet.rename_worksheet

view raw Examples-Ruby-Worksheet-rename_worksheet-.rb hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-python
	import os

	from asposecellscloud.apis.cells_api import CellsApi
	from asposecellscloud.models import *
	from asposecellscloud.requests import *

	api = CellsApi(os.getenv('CellsCloudClientId'),os.getenv('CellsCloudClientSecret'),"v3.0",os.getenv('CellsCloudApiBaseUrl'))
	request = PostRenameWorksheetRequest( 'Book1.xlsx', 'Sheet5', 'Sheet55',folder= 'PythonTest',storage_name= '')
	api.post_rename_worksheet(request)

view raw RenameExcelWorksheet.py hosted with ❤ by GitHub

Node.js

	const { CellsApi, UploadFileRequest, CellsWorksheets_PostRenameWorksheetRequest } = require("asposecellscloud");
	const clientId = process.env.CellsCloudClientId;
	const clientSecret = process.env.CellsCloudClientSecret;
	const ApiURL = process.env.CellsCloudApiBaseUrl;
	const fs = require('fs');
	const path = require('path');
	const cellsApi = new CellsApi(clientId, clientSecret,"v3.0",ApiURL);
	const localPath = "D:/aspose-cells-cloud-node/TestData/"

	const filename = "Book1.xlsx";
	const data =fs.createReadStream(path.join(localPath, filename));

	const req = new UploadFileRequest({
	path: "Temp/" + filename,
	file: data
	});
	cellsApi.uploadFile(req)
	.then((result) => {

	const req = new CellsWorksheets_PostRenameWorksheetRequest();
	req.name = filename;
	req.sheetName = "Sheet1";
	req.newname = "renametest";
	req.folder = "Temp";
	cellsApi.cellsWorksheetsPostRenameWorksheet(req)
	.then((result) => {
	console.log("successful")

	}).catch((error) => {
	console.error('Unhandled Promise Rejection:', error);
	})
	})

view raw Examples-Node.js-SDK-Worksheet-RenameWorksheet-1.js hosted with ❤ by GitHub

Android

Swift

Perl

	# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-perl/
	use strict;
	use warnings;
	use utf8;
	use File::Slurp;
	use MIME::Base64;
	use AsposeCellsCloud::CellsApi;
	my $config = AsposeCellsCloud::Configuration->new( client_id => $ENV{'ProductClientId'}, client_secret => $ENV{'ProductClientSecret'});
	my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));

	my $remoteFolder = 'TestData/In';
	my $remoteName = 'Book1.xlsx';
	my $request = AsposeCellsCloud::Request::PostRenameWorksheetRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet5';
	$request->{newname} = 'Sheet55';
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->post_rename_worksheet(request=> $request);

view raw Examples-Perl-Worksheet-RenameWorksheet-1.pl hosted with ❤ by GitHub