Get Structure In Remote Spreadsheet – Aspose.Cells Cloud API
The Get Structure In Remote Spreadsheet of Aspose.Cells Cloud Web Services
Structurally convert the core metadata, worksheets, tables, pivot tables, charts, shapes, and other information of an Excel workbook into a JObject type JSON object, for scenarios such as data export, API responses, and log recording.
Web API Endpoint
GET https://api.aspose.cloud/v4.0/cells/{name}/structure
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Request Parameters
| Parameter Name | Type | Path/Query String/HTTP Body | Description |
|---|---|---|---|
| name | string | Path | Name of the spreadsheet file. |
| folder | string | Query | Folder where the file is located. (Optional) |
| storageName | string | Query | (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted. |
| region | string | Query | Spreadsheet region/language setting (e.g., en-US, fr-FR). Influences number formatting, date parsing, and locale‑specific behavior. |
| password | string | Query | The password for opening spreadsheet file. |
Request Body Parameter
| Parameter Name | Type | Description |
|---|---|---|
| [TBD] | [TBD] | [TBD] |
Response
{
"Worksheets": [
{
"Name": "Sheet1",
"Tables": [],
"PivotTables": [],
"Charts": [],
"Shapes": []
}
],
"WorkbookProperties": {
"Author": "string",
"Created": "string",
"Version": "string"
},
"DocumentProperties": {
"Title": "string",
"Subject": "string",
"Keywords": "string"
}
}
Response Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Successfully retrieved workbook structure. |
| 400 | Bad Request | Invalid request parameters. |
| 401 | Unauthorized | Authentication failed or token missing. |
| 413 | Payload Too Large | The request payload exceeds the allowed size. |
| 500 | Internal Server Error | Unexpected server error. |
How to Use the Get Structure In Remote Spreadsheet with SDKs
Get Structure In Remote Spreadsheet Specification
The Get Structure In Remote Spreadsheet API Specification defines a publicly accessible programming interface and lets you perform 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.
Use Aspose Cells Cloud SDKs
Using an SDK is the fastest way to accelerate development. An SDK abstracts low-level details, allowing you to 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 Cloud web services using various SDKs:
[TBD]