Get all pictures in an Excel worksheet - Aspose.Cells Cloud API

This REST API retrieves all picture information from an Excel worksheet.

Prerequisites
Before calling this endpoint, ensure you have:

A valid Aspose Cloud JWT access token.
The target Excel file uploaded to the selected storage.
The correct storage name (if using a custom storage).
The worksheet name that contains the pictures.

GetWorksheetPictures API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/pictures

Note: Use HTTPS (TLS 1.2 or higher) when calling the API and include a valid JWT token in the Authorization header.

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

Request parameters

Parameter Name	Type	Location	Description
name	string	path	The name of the Excel file.
sheetName	string	path	The name of the worksheet containing pictures.
folder	string	query	The folder path where the file is stored.
storageName	string	query	The name of the storage service.

Error Responses

HTTP Code	Description
401	Unauthorized – missing or invalid token.
404	Not Found – the specified file, worksheet, or page‑break index does not exist.
400	Bad Request – malformed request syntax or invalid parameters.
500	Internal Server Error – an unexpected condition was encountered.

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/test.xlsx/worksheets/Sheet2/pictures" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response

{
  "Pictures": {
    "PictureList": [
      {
        "link": {
          "Href": "/0",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      },
      {
        "link": {
          "Href": "/1",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      },
      {
        "link": {
          "Href": "/2",
          "Rel": "self",
          "Title": null,
          "Type": null
        }
      }
    ],
    "link": {
      "Href": "/test.xlsx/worksheets/Sheet2/pictures",
      "Rel": "self",
      "Title": null,
      "Type": null
    }
  },
  "Code": 200,
  "Status": "OK"
}

Success Response – A successful call returns HTTP 200 with a JSON payload containing a Pictures object that lists each picture’s resource link.

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles low‑level details so you can 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:

You can download the SDKs directly from their respective package managers (e.g., NuGet for .NET, Maven Central for Java, Composer for PHP, npm for Node.js, PyPI for Python, CPAN for Perl, and Go modules for Go).

See also: Add a picture, Delete a picture, Update picture properties.

Add a Picture in an Excel File