Convert an Excel File to Different Formats This REST API indicates to convert excel file to different format file.
The request is an HTTP request with multipart content (see RFC 2046 or RFC 1341 ). The first part of the multipart content contains the data file and the second contains save options.
Query Parameter
Parameter Name
Type
Description
format
string
The file format: csv, xls, html, mhtml, ods, pdf, xml, txt, tiff, xlsb, xlsm, xlsx, xltm, xltx, xps, png, jpg, gif, emf, bmp, md, Numbers, wmf, svg, and so on.
password
string
The password needed to open an Excel file.
outPath
string
Path to save the result. If it’s a single file, the outPath should encompass both the filename and extension. In the case of multiple files, the outPath should only include the folder.
storageName
string
The storage name where the file is situated.
checkExcelRestriction
bool
Whether check restriction of excel file when user modify cells related objects.
streamFormat
string
The format of the input file stream.
region
string
The regional settings for workbook.
pageWideFitOnPerSheet
bool
The page wide fit on worksheet.
pageTallFitOnPerSheet
bool
The page tall fit on worksheet.
sheetName
string
Convert the specified worksheet.
pageIndex
string
Convert the specified page of worksheet, sheetName is required.
onePagePerSheet
bool
When converting to PDF format, one page per sheet.
AutoRowsFit
bool
Auto-fits all rows in this workbook.
AutoColumnsFit
bool
Auto-fits the columns width in this workbook.
Request Body Parameter
Parameter Name
Type
Description
datafile
data file
The data file save into the first part of the multipart content.
SaveOptions
Object
Save option save into the second part of the multipart content.
REST API
API Type Description Swagger Link
/cells/convert
PUT
Converts workbook from request content to some format
PutConvertWorkBook
The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.
You can use cURL command-line tool to access Aspose.Cells web services easily. The following example shows how to make calls to Cloud API with cURL.
Cloud SDK Family
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:
C#
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
namespace Aspose.Cells.Cloud.SDK.Tests.Api.Example
{
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Aspose.Cells.Cloud.SDK.Request;
using System.Collections.Generic;
using Aspose.Cells.Cloud.SDK.Api;
using System;
using System.IO;
[TestClass]
public class CellsApiExample
{
string CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
string CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
CellsApi cellsApi = new CellsApi(CellsCloudClientId, CellsCloudClientSecret);
string localName = "Book1.xlsx";
string localPath = "D:/TestData/CellsCloud";
string outputFilePath = "D:/Outpath";
[TestCategory("Cells")]
[TestMethod]
public void Example()
{
IDictionary<string, Stream> mapFiles = new Dictionary<string, Stream>();
mapFiles.Add(localName, File.OpenRead(localPath +"/"+ localName));
PutConvertWorkbookRequest request = new PutConvertWorkbookRequest { File = mapFiles, format = "pdf" };
var response = cellsApi.PutConvertWorkbook(request);
File.WriteAllBytes(outputFilePath, response);
}
}
}
Java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package com.aspose.cloud.cells.api;
import com.aspose.cloud.cells.client.*;
import com.aspose.cloud.cells.model.*;
import com.aspose.cloud.cells.request.*;
import java.io.IOException;
import org.junit.Test;
import java.util.ArrayList;
import java.util.List;
import java.io.File;
import java.util.HashMap;
public class Example {
private CellsApi api;
public Example(){
try {
String CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
String CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
api = new CellsApi(CellsCloudClientId, CellsCloudClientSecret);
} catch (ApiException e) {
e.printStackTrace();
}
}
public void Run(){
try{
String localName = "Book1.xlsx";
String localPath = "D:/TestData/CellsCloud";
String format = "pdf";
PutConvertWorkbookRequest request = new PutConvertWorkbookRequest();
request.setFormat(format);
HashMap<String,File> fileMap = new HashMap<String,File>();
fileMap.put(localName ,CellsApiUtil.GetFileHolder(localPath"+"localName) );
request.setFile(fileMap);
this.api.putConvertWorkbook(request);
} catch (ApiException e) {
e.printStackTrace();
}catch (IOException e) {
e.printStackTrace();
}
}
}
PHP
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php
require_once('vendor\autoload.php');
use \Aspose\Cells\Cloud\Api\CellsApi;
use \Aspose\Cells\Cloud\Request\PutConvertWorkbookRequest;
$CellsCloudClientId = "...." ; # get from https://dashboard.aspose.cloud/#/applications
$CellsCloudClientSecret = "...."; # get from https://dashboard.aspose.cloud/#/applications
$cellsApi = new CellsApi($CellsCloudClientId , $CellsCloudClientSecret );
$request = new PutConvertWorkbookRequest();
$request->setFile( 'TestData/Book1.xlsx');
$request->setFormat("pdf");
$response = $cellsApi->putConvertWorkbook($request);
copy($response->getPathname(),"Book1.pdf");
Ruby
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
require 'openssl'
require 'bundler'
require 'aspose_cells_cloud'
CellsCloudClientId = "...." # get from https://dashboard.aspose.cloud/#/applications
CellsCloudClientSecret = "...." # get from https://dashboard.aspose.cloud/#/applications
@instance = AsposeCellsCloud::CellsApi.new(CellsCloudClientId, CellsCloudClientSecret)
local_name = 'Book1.xlsx'
format = "pdf"
mapFiles = { }
mapFiles[local_name]= ::File.open(File.expand_path("TestData/"+local_name),"r")
request = AsposeCellsCloud::PutConvertWorkbookRequest.new(:File=>mapFiles,:format=>format);
@instance.put_convert_workbook(request);
Node.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { CellsApi, PutConvertWorkbookRequest } from "asposecellscloud";
var fs = require('fs');
var path = require('path');
var process = require('process');
const _ = require('asposecellscloud');
const CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
const CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
const cellsApi = new CellsApi(CellsCloudClientId, CellsCloudClientSecret);
var localPath = "TestData/CellsCloud/"
var localName = "Book1.xlsx"
describe('example', function(){
it("should call successfully" , function(){
var format = "pdf"
var mapFiles = {};
mapFiles[localName]= fs.createReadStream(localPath +localName) ;
var request = new PutConvertWorkbookRequest();
request.file = mapFiles;
request.format = format;
return cellsApi.putConvertWorkbook(request)
});
});
Python
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import os
import shutil
import sys
from asposecellscloud.apis.cells_api import CellsApi
from asposecellscloud.models import *
from asposecellscloud.requests import *
CellsCloudClientId ='....' # get from https://dashboard.aspose.cloud/#/applications
CellsCloudClientSecret='....' # get from https://dashboard.aspose.cloud/#/applications
api = CellsApi(CellsCloudClientId,CellsCloudClientSecret)
response = api.put_convert_workbook(PutConvertWorkbookRequest("Book1.xlsx",format= "pdf"))
shutil.move( response ,"Book12.pdf")
Perl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
use lib 'lib';
use strict;
use warnings;
use File::Slurp;
use MIME::Base64;
use AsposeCellsCloud::CellsApi;
my $CellsCloudClientId = "...."; # get from https://dashboard.aspose.cloud/#/applications
my $CellsCloudClientSecret = "...."; # get from https://dashboard.aspose.cloud/#/applications
my $config = AsposeCellsCloud::Configuration->new( client_id => $CellsCloudClientId , client_secret => $CellsCloudClientSecret );
my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));
my $localName = 'Book1.xlsx';
my $format = 'pdf';
my $mapFiles = {};
$mapFiles->{$localName}= "TestData/".$localName ;
my $request = AsposeCellsCloud::Request::PutConvertWorkbookRequest->new();
$request->{file} = $mapFiles;
$request->{format} = $format;
$instance->put_convert_workbook(request=> $request);
Go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package main
import (
"os"
. "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v25"
)
func main() {
println("Hello Aspose.Cells Cloud!")
CellsCloudClientId := "...." // get from https://dashboard.aspose.cloud/#/applications
CellsCloudClientSecret := "...." // get from https://dashboard.aspose.cloud/#/applications
instance := NewCellsApiService(CellsCloudClientId, CellsCloudClientSecret)
request := PutConvertWorkbookRequest{File: map[string]string{"Book1.xlsx": "TestData/Book1.xlsx"}, Format: "pdf"}
data, _, err := instance.PutConvertWorkbook(&request)
if err == nil {
file, _ := os.OpenFile("Book1.pdf", os.O_WRONLY|os.O_CREATE|os.O_APPEND, 0644)
file.Write(data)
defer file.Close()
}
}