Sort ListObject Data in an Excel Worksheet – Aspose.Cells Cloud API

Prerequisites
To call this API you must have a valid Aspose Cloud JWT access token and the workbook must be uploaded to Aspose Cloud storage. Include the header Authorization: Bearer <jwt token> in every request.

This REST API sorts a table’s data in an Excel worksheet.
To use this operation, provide the workbook name, worksheet name, and the index of the target ListObject, together with a dataSorter JSON body that defines the sorting criteria.

REST API

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

Request parameters

Parameter Name	Type	Path/Query String/HTTPBody	Description
name	string	path	The name of the Excel file stored in Aspose Cloud storage.
sheetName	string	path	The name of the worksheet that contains the ListObject.
listObjectIndex	integer	path	Zero‑based index of the ListObject (table) within the worksheet.
dataSorter	object	body	JSON object that specifies sorting options (e.g., `CaseSensitive`, `HasHeaders`, `KeyList`, `SortLeftToRight`).
folder	string	query	Folder path in storage where the Excel file is located.
storageName	string	query	Name of the Aspose Cloud storage.

Notes
The request body must be a valid JSON object matching the dataSorter schema. Ensure that the workbook, worksheet, and ListObject exist before invoking the sort operation.

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

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

Request

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/sheet7/listobjects/1/sort" \
  -X POST \
  -d '{
        "CaseSensitive": true,
        "HasHeaders": true,
        "KeyList": [
          {
            "Key": 1,
            "SortOrder": "Ascending",
            "CustomList": "string"
          }
        ],
        "SortLeftToRight": true
      }' \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

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

HTTP Status Codes

Status Code	Description
200	OK – sorting completed successfully.
400	Bad Request – invalid parameters.
401	Unauthorized – authentication failed.
404	Not Found – workbook, worksheet, or ListObject not found.
500	Internal Server Error – server‑side issue.

Response Parameters

Parameter	Type	Description
Code	integer	HTTP status code returned by the API.
Status	string	Textual description of the result (e.g., “OK”).

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles 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 call Aspose.Cells web services using various SDKs:

Back to ListObjects Overview

Convert List Object to Range – Aspose.Cells Cloud API