Sort range data on an Excel worksheet

This REST API indicates sort worksheet range data.

RSET API

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

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path	The workbook name.
sheetName	string	path	The worksheet name.
cellArea	string	query	The range to sort.
dataSorter		body	with sorting settings.
folder	string	query	The workbook folder.
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/sort?cellArea=A5:A10" \
-X POST \
-d '{"CaseSensitive":false, "HasHeaders":false, "KeyList":[{"Key":0, "SortOrder":"descending"}], "SortLeftToRight":false}' \
-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 PostWorksheetRangeSortExample()
	{
	CellsApi cellsApi = new CellsApi(Environment.GetEnvironmentVariable("CellsCloudTestClientId"), Environment.GetEnvironmentVariable("CellsCloudTestClientSecret"));
	PostWorksheetRangeSortRequest request = new PostWorksheetRangeSortRequest { name = "Book1.xlsx", sheetName = "Sheet1", cellName = "A1", comment = new Model.Comment { CellName = "A1", IsVisible = true }, folder = "TestData/In" };
	cellsApi.PostWorksheetRangeSort(request);
	}
	}
	}
	// Obsolete
	//CellsWorksheetsApi instance = new CellsWorksheetsApi(GetConfiguration());
	//string name = "Book1.xlsx";
	//string sheetName = "Sheet1";
	//string cellArea = "A1:C10";
	//DataSorter dataSorter = new DataSorter();
	//dataSorter.CaseSensitive = true;
	//string folder = null;
	//UpdateDataFile(folder, name);
	//var response = instance.CellsWorksheetsPostWorksheetRangeSort(name, sheetName, cellArea, dataSorter, folder);

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

Java

	package com.aspose.cloud.cells.api;
	import com.aspose.cloud.cells.client.*;
	import com.aspose.cloud.cells.model.*;
	import com.aspose.cloud.cells.request.*;
	import java.io.IOException;
	import org.junit.Test;
	import java.util.ArrayList;
	import java.util.List;
	import java.io.File;
	import java.util.HashMap;

	public class Example {
	private CellsApi api;
	public Example(){
	try {
	api = new CellsApi(
	System.getenv("CellsCloudClientId"),
	System.getenv("CellsCloudClientSecret"),
	"v3.0",
	System.getenv("CellsCloudApiBaseUrl")
	);
	} catch (ApiException e) {
	e.printStackTrace();
	}
	}
	public void Run(){
	try{
	String remoteFolder = "TestData/In";
	String localName = "Book1.xlsx";
	String remoteName = "Book1.xlsx";

	UploadFileRequest uploadFileRequest = new UploadFileRequest();
	uploadFileRequest.setPath( remoteFolder + "/" + remoteName );
	uploadFileRequest.setStorageName( "");
	HashMap<String,File> files = new HashMap<String,File>();
	files.put( localName , new File(localName ));
	uploadFileRequest.setUploadFiles(files);
	api.uploadFile(uploadFileRequest);

	DataSorter dataSorter = new DataSorter();
	dataSorter.setCaseSensitive(true);
	PostWorksheetRangeSortRequest request = new PostWorksheetRangeSortRequest();
	request.setName(remoteName);
	request.setSheetName("Sheet1");
	request.setCellArea("cellArea");

	request.setDataSorter(dataSorter);
	request.setFolder(remoteFolder);
	request.setStorageName("");

	CellsCloudResponse response = api.postWorksheetRangeSort(request);

	} catch (ApiException e) {
	e.printStackTrace();
	}catch (IOException e) {
	e.printStackTrace();
	}
	}
	}

view raw Examples-Java-worksheet-SortWorksheetData-sort-worksheet-data.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\PostWorksheetRangeSortRequest;

	class Worksheet {

	public $instance;

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

	}

	public function postWorksheetRangeSort() {
	$remoteFolder = "TestData/In";
	$localName = "Book1.xlsx";
	$remoteName = "Book1.xlsx";
	$dataSorter = new \Aspose\Cells\Cloud\Model\DataSorter();
	$dataSorter->setCaseSensitive('true' );
	$request = new PostWorksheetRangeSortRequest();
	$request->setName( $remoteName);
	$request->setSheetName( "Sheet1");
	$request->setCellArea( "A1:C10");
	$request->setDataSorter( $dataSorter);
	$request->setFolder( $remoteFolder);
	$request->setStorageName( "");
	$this->instance->postWorksheetRangeSort($request);
	}
	}

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

	?>

view raw Examples-PHP-Worksheet-PostWorksheetRangeSort-.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

	# Sort worksheet range.
	def sort_worksheet_range
	name = $BOOK1
	sheet_name = $SHEET1
	cell_area = $CELLAREA
	data_sorter = AsposeCellsCloud::DataSorter.new(:CaseSensitive=>true)
	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_worksheet_range_sort(name, sheet_name, cell_area, {:data_sorter=>data_sorter, :folder=>folder})
	expect(result.code).to eql(200)
	end

	end

	worksheet = Worksheet.new()
	puts worksheet.sort_worksheet_range

view raw Examples-Ruby-Worksheet-sort_worksheet_range-.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'))
	dataSorter = DataSorter(case_sensitive= True )
	request = PostWorksheetRangeSortRequest( 'Book1.xlsx', 'Sheet1', 'A1:C10', dataSorter,folder= 'PythonTest',storage_name= '')
	api.post_worksheet_range_sort(request)

view raw SortWorkSheetData.py hosted with ❤ by GitHub

Node.js

	const { CellsApi, UploadFileRequest, CellsWorksheets_PostWorksheetRangeSortRequest,DataSorter } = 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_PostWorksheetRangeSortRequest();
	req.name = filename;
	req.sheetName = "Sheet1";
	req.cellArea = "A1:C10";
	req.dataSorter = new DataSorter();
	req.dataSorter.caseSensitive = true;
	req.folder = "Temp";
	cellsApi.cellsWorksheetsPostWorksheetRangeSort(req)
	.then((result) => {
	console.log("successful")

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

view raw Examples-Node.js-SDK-Worksheet-SortWorksheetData-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 $data_sorter = AsposeCellsCloud::Object::DataSorter->new();
	$data_sorter->{case_sensitive} = 'true' ;

	my $request = AsposeCellsCloud::Request::PostWorksheetRangeSortRequest->new();
	$request->{name} = $remoteName;
	$request->{sheet_name} = 'Sheet1';
	$request->{cell_area} = 'A1:C10';
	$request->{data_sorter} = $data_sorter;
	$request->{folder} = $remoteFolder;
	$request->{storage_name} = '';
	my $result = $api->post_worksheet_range_sort(request=> $request);

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