Get Worksheet Comment – Aspose.Cells Cloud API Documentation

This REST API retrieves a worksheet comment by cell name using Aspose.Cells Cloud.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/comments/{cellName}

Request Parameters

Parameter Name	Type	Location (URL Path / Query String)	Description
name	string	URL Path	The name of the Excel file.
sheetName	string	URL Path	The name of the worksheet that contains the comment.
cellName	string	URL Path	The cell address (e.g., A1) whose comment is being retrieved.
folder	string	Query String	The folder path where the document is stored.
storageName	string	Query String	The name of the storage service.

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 a call to the Cloud API with cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/Sheet1/comments/A1" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "Comment": {
    "CellName": "A1",
    "Author": "roy.wang",
    "HtmlNote": "",
    "Note": "Aspose.Cells Cloud.",
    "AutoSize": "True",
    "IsVisible": "True",
    "Width": 30,
    "Height": 10,
    "TextHorizontalAlignment": "Bottom",
    "TextOrientationType": "TopToBottom",
    "TextVerticalAlignment": "Bottom"
  },
  "Code": 200,
  "Status": "OK"
}

Common Errors

401 Unauthorized – Verify that the JWT token is valid, not expired, and correctly placed in the Authorization header.
404 Not Found – Ensure the file name, worksheet name, and cell address are correct and that the file exists in the specified folder/storage.
500 Internal Server Error – Check the request payload for malformed data and confirm that the service is operational.

Cloud SDK Family

Using an SDK is the best way to speed up development. An SDK handles 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:

Add Worksheet Comment