Save spreadsheet as

Excel API : SaveSpreadsheetAs

Overview

Converts a spreadsheet in cloud storage to the specified format.

Function Description

This method accesses a spreadsheet file directly from cloud storage, converts it into the desired output format (e.g., XLSX, PDF, CSV), and returns the converted result without downloading the file to the local system. Ensure that the cloud storage configuration (such as access credentials and file path) is correctly set up. The conversion process happens entirely within the cloud environment, minimizing data transfer overhead and enhancing security by keeping sensitive data within the cloud infrastructure. If the source file does not exist, or if an error occurs during the conversion process, an appropriate exception will be thrown. Supported output formats depend on the underlying conversion service capabilities.

API Endpoint

PUT http://api.aspose.cloud/v4.0/cells/{name}/saveas

The request parameters of saveSpreadsheetAs API are:

Parameter Name Type Path/Query String/HTTPBody Description
name String Path (Required) The name of the workbook file to be converted.
format String Query (Required) The desired output format (e.g., “Xlsx”, “Pdf”, “Csv”).
saveOptionsData Class Body (Optional) Save options data. The default is null.
folder String Query (Optional) The folder path where the workbook is stored. The default is null.
storageName String Query (Optional) The name of the storage if using custom cloud storage. Use default storage if omitted.
outPath String Query (Optional) The folder path where the workbook is stored. The default is null.
outStorageName String Query Output file Storage Name.
fontsLocation String Query Use Custom fonts.
regoin String Query The spreadsheet region setting.
password String Query The password for opening spreadsheet file.

Response Structure

{
  "Name": "CellsCloudResponse",
  "Type": "Class",
  "IsAbstract": false,
  "Properties": [
    {
      "Name": "Code",
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": false,
      "DataType": {
        "Identifier": "Integer",
        "Name": "integer"
      }
    },
    {
      "Name": "Status",
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": false,
      "DataType": {
        "Identifier": "String",
        "Name": "string"
      }
    }
  ]
}

Error Handling

  • 400 Bad Request: Invalid url.
  • 401 Unauthorized: Authentication has failed, or no credentials were provided.
  • 404 Not Found: Source file not accessible.
  • 500 Server Error The spreadsheet has encountered an anomaly in obtaining conversion data.

Usage Scenarios

Key Features and Benefits

  • Cloud-Based Conversion: Directly accesses and converts spreadsheet files in cloud storage to desired formats (e.g., XLSX, PDF, CSV).
  • Efficient Data Handling: Minimizes data transfer by performing conversions remotely.Enhances security by keeping sensitive data within the cloud infrastructure.
  • Convenience: Simplifies the conversion process by handling everything in the cloud.

OpenAPI Specification

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

Excel API SDK

Using an SDK is the best way to speed up the development. An SDK takes care of 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: