Aspose.Cells Cloud API – Get List Object (Table) from Worksheet
This REST API retrieves a list object (table) from an Excel worksheet and can export the list object to different file formats. All calls must be made over HTTPS.
REST API
GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listobjectindex}
Request parameters
| Parameter Name | Type | Location | Description | Required/Optional |
|---|---|---|---|---|
| name | string | path | The name of the Excel file. | Required |
| sheetName | string | path | The name of the worksheet containing the list object. | Required |
| listobjectindex | integer | path | Zero‑based index of the list object to retrieve. | Required |
| format | string | query | Desired export format (e.g., pdf, csv, json). |
Optional |
| folder | string | query | Folder path where the workbook is stored. | Optional |
| storageName | string | query | Name of the Aspose Cloud storage to use. | Optional |
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.
Error handling
– The API can return the following status codes:
| HTTP Code | Meaning | Example JSON error body |
|---|---|---|
| 400 | Bad request – missing/invalid parameters | {"Code":400,"Message":"Invalid format parameter."} |
| 401 | Unauthorized – invalid or missing JWT token | {"Code":401,"Message":"Authentication failed."} |
| 404 | Not found – workbook, worksheet, or list object does not exist | {"Code":404,"Message":"ListObject not found."} |
| 500 | Internal server error | {"Code":500,"Message":"Unexpected server error."} |
Next steps – After retrieving the ListObject, you can manipulate its rows/columns via the corresponding SDK methods or export the table directly by adding the format query parameter (e.g., ?format=csv).
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 make calls to Aspose.Cells web services using various SDKs: