Get a Shape by Index on an Excel Worksheet – Aspose.Cells Cloud Documentation
This REST API retrieves a shape (including its image data or metadata) from an Excel worksheet.
REST API
GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/shapes/{shapeindex}
Prerequisites
- A valid Aspose Cloud access token (Bearer JWT).
- The workbook must be stored in your Aspose Cloud storage or a specified folder.
Request parameters
| Parameter Name | Type | Location | Description |
|---|---|---|---|
| name | string | path | Name of the Excel document. |
| sheetName | string | path | Name of the worksheet containing the shape. |
| shapeindex | integer | path | Zero‑based index of the shape within the worksheet. |
| folder | string | query | Folder path where the document is stored. |
| storageName | string | query | Name of the storage service. |
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 a call to the Cloud API with cURL.
Possible HTTP status codes
| Code | Description |
|---|---|
| 200 OK | The shape was retrieved successfully. |
| 400 Bad Request | The request is malformed or missing required parameters. |
| 401 Unauthorized | Authentication failed or token is missing/invalid. |
| 404 Not Found | The specified workbook, worksheet, or shape index does not exist. |
| 500 Internal Server Error | An unexpected server error occurred. |
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:
For related operations, see the documentation on Adding a Shape and Updating a Shape.