Build Excel Reports with Smart Marker Templates – Aspose.Cells Cloud API Guide
This REST API creates a workbook using a Smart Marker template.
Workbook SmartMarker API
POST https://api.aspose.cloud/v3.0/cells/{name}/smartmarker
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
What is a Smart Marker?
A Smart Marker is a placeholder syntax that maps data fields in an XML (or JSON) file to cells in an Excel template. At runtime Aspose.Cells replaces the markers with the corresponding data, allowing you to generate fully populated reports programmatically.
Query Parameters
| Parameter Name | Type | Description |
|---|---|---|
| outPath | string | Destination path where the generated workbook will be saved. |
| folder | string | Folder containing the original workbook. |
| storageName | string | Name of the storage service to use. |
Request Body Parameter
| Parameter Name | Type | Description |
|---|---|---|
| xmlFile | file | Smart Marker XML data file uploaded with the request. |
Response
{
"Name": "ResponseFile",
"DataType": {
"Identifier": "File",
"Reference": "Stream",
"Name": "file"
}
}
Notes / Limitations:
- The API supports Excel files up to 50 MB in size.
- Accepted formats are .xlsx, .xlsm, and .xlsb only.
- A rate limit of 20 requests per second per account is enforced.
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. |
How to Use the Workbook SmartMarker API
Workbook SmartMarker API Specification
The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.
Use Aspose.Cells Cloud SDKs
You can use 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.
Quick one‑liner example
curl -X POST "https://api.aspose.cloud/v3.0/cells/{name}/smartmarker?outPath={outPath}" -H "Authorization: Bearer {access_token}" -F "xmlFile=@Sample_SmartMarker_Data.xml"
Error Handling
| HTTP Status | Description | Typical Cause |
|---|---|---|
| 400 | Bad Request | Missing template, malformed XML, or invalid parameters. |
| 401 | Unauthorized | Invalid or missing authentication token. |
| 404 | Not Found | Specified workbook or storage location does not exist. |
| 500 | Internal Server Error | Unexpected server‑side failure. |
Example error response (400)
{
"Code": 400,
"Message": "The XML data file is missing or malformed."
}
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 call Aspose.Cells web services using various SDKs: