Aspose.Cells Cloud – Convert Excel Workbook to PDF, CSV, HTML, and More (GET /cells/{name})

This REST API retrieves an Excel workbook in a different format.

GetWorkBook API

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

Security and Authentication

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

Query Parameters

Parameter Name Type Description Default
format string Target file format (e.g., CSV, XLS, HTML, MHTML, ODS, PDF, XML, TXT, TIFF, XLSB, XLSM, XLSX, XLTM, XLTX, XPS, PNG, JPG, GIF, EMF, BMP, MD, Numbers, WMF, SVG, etc.). –
password string Password required to open the Excel file. –
isAutoFit bool Automatically fits rows and columns width. false
onlySaveTable bool When true, only table data is saved. Accepts true or false. false
outPath string Path to save the result. For a single file, include the filename and extension; for multiple files, specify only the folder. –
outStorageName string Name of the storage where the output file will be saved. –
checkExcelRestriction bool Checks Excel restrictions when modifying cells or related objects. false
region string Regional settings applied to the workbook. –
pageWideFitOnPerSheet bool Fits the page width to each worksheet when converting to PDF. false
pageTallFitOnPerSheet bool Fits the page height to each worksheet when converting to PDF. false
onePagePerSheet bool Generates one PDF page per worksheet. false
folder string Folder path of the original workbook. –
storageName string Name of the storage where the source file is located. –

Response

Success (200)

  • The API returns a Workbook object that contains workbook structure info when the format query parameter is omitted.

  • The API returns the converted file in the requested format when the format query parameter specifies a file type.

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="book1.pdf"
Content-Length: 123456

(binary PDF data)

HTTP Status Codes

Code Meaning Description
200 OK Filter applied successfully; response contains operation details.
400 Bad Request Missing or invalid parameters (e.g., unsupported file type).
401 Unauthorized Invalid or missing JWT token.
413 Payload Too Large Uploaded file exceeds size limit.
500 Internal Server Error Unexpected server error.

Notes:

  • Large workbooks may take longer to convert; consider increasing the request timeout.
  • Some formats (e.g., ODS) are not supported for certain Excel features such as macros.

How to Use the GetWorkBook API with SDKs

Prerequisites:

  • A valid JWT access token obtained via the Aspose.Cells authentication flow.
  • The source workbook must be stored in a supported Aspose storage or supplied directly in the request.
  • Ensure the API version (v3.0) matches the latest released version.

GetWorkBook API Specification

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

Example Request

You can use the cURL command‑line tool to access Aspose.Cells web services. The following example shows a correct GET request with the required authorization header.

Use Aspose.Cells Cloud SDKs

Using an SDK is the fastest way to develop. An SDK abstracts low‑level details so you can focus on your project tasks. Please check 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:

See Also

Last Updated: 2024-12-01

Convert Excel to HTML Save Excel Workbook – Aspose.Cells Cloud API