Add Background Image to Workbook
REST API
This REST API adds a background image to an Excel workbook.
POST https://api.aspose.cloud/v3.0/cells/{name}/background
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Query Parameters
| Parameter Name | Type | Description |
|---|---|---|
picPath |
string | Path to the picture file to be used as background. |
folder |
string | Folder that contains the original workbook. |
storageName |
string | Name of the storage where the file resides. |
Request Body Parameter
| Parameter Name | Type | Description |
|---|---|---|
datafile |
file | The workbook file to which the background will be applied. |
Path Parameter – {name} in the URL represents the workbook file name (e.g., Book1.xlsx).
Response
{
"Status" : "OK",
"Code" : 200
}
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 PutWorkbookBackground API with SDKs
PutWorkbookBackground API Specification
The OpenAPI Specification defines a publicly accessible programming interface that lets you perform 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 a complete request, including the multipart file upload flag and the required authentication header.
Use Aspose.Cells Cloud SDKs
Using an SDK is the fastest way to develop. An SDK abstracts low‑level details so you can concentrate on your business logic. See 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: