Delete Worksheet Comment API – Aspose.Cells Cloud
Overview
A comment is a text note attached to a specific cell in an Excel worksheet. This REST API deletes such a comment from a worksheet cell.
Security and Authentication
The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.
Prerequisites
- A valid JWT access token for Aspose.Cells Cloud.
- Access to the storage location where the Excel file resides.
- The target workbook must exist in the specified folder (or root) of the chosen storage.
- Optional: SDK installed for your preferred language if you prefer using code snippets instead of raw HTTP calls.
REST API
DELETE https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/comments/{cellName}
Request Parameters
The endpoint accepts the following parameters:
| Parameter Name | Type | Location | Required | Description |
|---|---|---|---|---|
| name | string | path | Yes | The name of the Excel document. |
| sheetName | string | path | Yes | The name of the worksheet. |
| cellName | string | path | Yes | The address of the cell (e.g., A1). |
| folder | string | query | No | The folder that contains the document. |
| storageName | string | query | No | The name of the storage service. |
Request Example
Error Responses
| HTTP Code | Description | Example Response |
|---|---|---|
| 400 | Bad request – missing or malformed parameters. | { "Code": 400, "Message": "Invalid parameters." } |
| 401 | Unauthorized – invalid or missing token. | { "Code": 401, "Message": "Authentication required." } |
| 404 | Not found – the file, worksheet, or comment does not exist. | { "Code": 404, "Message": "Resource not found." } |
| 500 | Internal server error – unexpected condition on the server. | { "Code": 500, "Message": "Server error." } |
For a complete list of status codes, refer to the Error Responses section above.
The OpenAPI Specification for DeleteWorksheetComment provides a machine‑readable description of this endpoint.
Cloud SDK Family
Using an SDK can speed up development. An SDK handles low‑level details and lets you focus on your project tasks. Please check out the GitHub repository for Aspose.Cells Cloud SDKs for a complete list.
The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:
Related operations: Add Worksheet Comment, Update Worksheet Comment.