获取工作表注释 – Aspose.Cells Cloud API 文档

此 REST API 可通过Aspose.Cells Cloud按单元格名称获取工作表注释。

前置条件：调用此操作前，您必须在 Authorization 请求头中包含有效的 JWT 访问令牌（格式为 Bearer <jwt token>）。令牌可通过身份验证指南中所述的 Aspose.Cells Cloud 身份验证流程获取。

GetWorksheetComment API

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

安全与身份验证

Aspose.Cells Cloud API 采用安全机制，需使用基于 JWT 令牌的身份验证。

请求参数

参数名称	类型	位置（URL 路径 / 查询字符串）	描述
name	string	URL 路径	Excel 文件的名称。
sheetName	string	URL 路径	包含注释的工作表名称。
cellName	string	URL 路径	要获取注释的单元格地址（例如 A1）。
folder	string	查询字符串	文档所在的文件夹路径。
storageName	string	查询字符串	存储服务的名称。

OpenAPI 规范定义了一个公开可访问的编程接口，允许您直接通过网页浏览器执行 REST 交互。

您可以使用 cURL 命令行工具轻松访问 Aspose.Cells Web 服务。以下示例展示了如何通过 cURL 调用 Cloud API。

请求

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>"

响应

{
  "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"
}

响应说明：API 返回一个 JSON 对象，其中包含一个 Comment 对象，字段如下：

字段名	类型	描述
`CellName`	string	单元格地址（例如 A1）。
`Author`	string	注释作者姓名。
`HtmlNote`	string	注释的 HTML 格式内容（若存在）。
`Note`	string	注释的纯文本内容。
`AutoSize`	boolean	是否自动调整注释框大小。
`IsVisible`	boolean	注释是否可见。
`Width`	integer	注释框宽度（以字符数为单位）。
`Height`	integer	注释框高度（以字符数为单位）。
`TextHorizontalAlignment`	string	文本水平对齐方式（例如 Bottom）。
`TextOrientationType`	string	文本方向（例如 TopToBottom）。
`TextVerticalAlignment`	string	文本垂直对齐方式（例如 Bottom）。

常见错误

401 未授权（Unauthorized） – 请确认 JWT 令牌有效、未过期，并正确放置于 Authorization 请求头中。
404 未找到（Not Found） – 请确认文件名、工作表名和单元格地址正确，并且文件存在于指定文件夹/存储中。
500 内部服务器错误（Internal Server Error） – 请检查请求载荷数据格式是否正确，并确认服务是否正常运行。

HTTP 状态码

状态码	含义	描述
200	OK（成功）	筛选器应用成功；响应包含操作详情。
400	Bad Request	缺失或无效参数（例如不支持的文件类型）。
401	Unauthorized	JWT 令牌无效或缺失。
413	Payload Too Large	上传文件超过大小限制。
500	Internal Server Error	服务器内部错误。

云 SDK 开发工具包（SDK Family）

使用 SDK 是加速开发的最佳方式。SDK 能自动处理底层细节，让您专注于项目核心任务。请查阅 GitHub 仓库以获取 Aspose.Cells Cloud SDK 的完整列表。

以下代码示例展示了如何使用不同 SDK 调用 Aspose.Cells Web 服务：

更新工作表单元格批注