How to Create an Excel Workbook with a Template File
REST API
This REST API creates a workbook from a template file. It generates a new Excel workbook based on the supplied template and data.
PUT 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
Query Parameters – key‑value pairs that control workbook creation.
| Parameter Name | Type | Description |
|---|---|---|
templateFile |
string | Name of the template file stored in the cloud. |
dataFile |
string | Name of the data file (e.g., XML, JSON) used to populate the template. |
isWriteOver |
boolean | Flag indicating whether to overwrite an existing file. Pass true or false without quotes. |
folder |
string | Folder path where the original workbook resides. |
storageName |
string | Name of the storage service. |
Request Body Parameter
Request Body – contains the data file for Smart‑Marker placeholders.
| Parameter Name | Type | Description |
|---|---|---|
data |
file | File containing the data for the smart‑marker template (XML or JSON). |
Response
{
"Name": "ResponseFile",
"DataType": {
"Identifier": "File",
"Reference": "Stream",
"Name": "file"
}
}
Response Status Codes
| Code | Meaning | Description |
|---|---|---|
| 200 | OK | Compression succeeded; response contains compressed file 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. |
How to Use the PutWorkbookCreate API with SDKs
PutWorkbookCreate API Specification
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.
Use Aspose.Cells Cloud SDKs
Using an SDK is the best way to speed up development. An SDK abstracts low‑level details, letting 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: