Получить комментарий листа – Документация API Aspose.Cells Cloud
Этот REST API извлекает комментарий листа по имени ячейки с использованием Aspose.Cells Cloud.
Необходимые условия: Для вызова данной операции необходимо включить действительный JWT-токен доступа в заголовке Authorization (Bearer <jwt token>). Токены можно получить в рамках процесса аутентификации Aspose.Cells Cloud, описанного в Руководстве по аутентификации.
API GetWorksheetComment
GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/comments/{cellName}
Безопасность и аутентификация
API Aspose.Cells Cloud защищены и требуют аутентификации на основе JWT-токена.
Параметры запроса
| Имя параметра | Тип | Расположение (путь URL / строка запроса) | Описание |
|---|---|---|---|
| name | string | Путь URL | Имя файла Excel. |
| sheetName | string | Путь URL | Имя листа, содержащего комментарий. |
| cellName | string | Путь URL | Адрес ячейки (например, A1), комментарий которой извлекается. |
| folder | string | Строка запроса | Путь к папке, в которой хранится документ. |
| storageName | string | Строка запроса | Имя службы хранения. |
Спецификация OpenAPI определяет публично доступное программное интерфейсное решение и позволяет выполнять REST-взаимодействия непосредственно из веб-браузера.
Вы можете использовать утилиту командной строки cURL для простого доступа к веб-сервисам Aspose.Cells. В следующем примере показано, как выполнить вызов Cloud API с помощью cURL.
Ответ: 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 — лучший способ ускорить разработку. SDK берёт на себя обработку низкоуровневых деталей, позволяя сосредоточиться на задачах проекта. Полный список SDK Aspose.Cells Cloud доступен в репозитории GitHub.
Следующие примеры кода демонстрируют, как выполнять вызовы веб-сервисов Aspose.Cells с использованием различных SDK: