Обновление объекта списка в рабочей книге Excel – Документация API Aspose.Cells Cloud
Этот REST API обновляет свойства объекта списка (таблицы) в рабочей книге Excel.
Безопасность и аутентификация
API Aspose.Cells Cloud защищены и требуют аутентификации на основе токена JWT.
Схема тела запроса
DTO listObject содержит следующие поля. В теле запроса необходимо указать только те поля, значения которых вы хотите изменить.
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| DisplayName | string | необязательное | Отображаемое имя таблицы. |
| StartRow / StartColumn | integer | необязательное | Индекс первой строки/столбца таблицы (начинается с 0). |
| EndRow / EndColumn | integer | необязательное | Индекс последней строки/столбца таблицы (начинается с 0). |
| Range | string | необязательное | Адрес диапазона таблицы в стиле A1 (например, A1:D10). |
| ShowHeaderRow | boolean | необязательное | true, чтобы отобразить строку заголовков. |
| ShowTotals | boolean | необязательное | true, чтобы отобразить строку итогов. |
| TableStyleName | string | необязательное | Имя встроенного стиля таблицы для применения. |
| TableStyleType | string | необязательное | Тип стиля (TableStyleLight, TableStyleMedium и т.д.). |
| ListColumns | array of objects | необязательное | Коллекция определений столбцов (Name, TotalsCalculation). |
| Sorter, AutoFilter, ShowTableStyle… | object | необязательное | Дополнительные параметры стилизации и фильтрации (см. полный DTO в спецификации OpenAPI). |
Минимальный пример полезной нагрузки
{
"DisplayName": "SalesData",
"Range": "A1:E20",
"ShowHeaderRow": true,
"ShowTotals": false
}
REST API
POST https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}
Параметры запроса
| Имя параметра | Тип | Расположение | Описание |
|---|---|---|---|
| name | string | путь | Имя документа. |
| sheetName | string | путь | Имя рабочего листа. |
| listObjectIndex | integer | путь | Индекс объекта списка, который необходимо обновить. |
| listObject | object | тело | DTO ListObject в теле запроса. |
| folder | string | query | Папка, содержащая документ. |
| storageName | string | query | Имя хранилища. |
Спецификация OpenAPI определяет публично доступное программное интерфейсное описание и позволяет выполнять взаимодействие по REST непосредственно из веб-браузера.
Запрос
Ответы об ошибках
| Код HTTP | Описание | Пример полезной нагрузки |
|---|---|---|
| 400 | Неверный запрос — отсутствуют обязательные поля или некорректный JSON. | { "Code": 400, "Message": "Invalid request body." } |
| 401 | Неавторизованный запрос — отсутствует или недействителен токен JWT. | { "Code": 401, "Message": "Authentication failed." } |
| 404 | Не найдено — указанная рабочая книга, рабочий лист или объект списка не существует. | { "Code": 404, "Message": "Resource not found." } |
| 500 | Внутренняя ошибка сервера — непредвиденное состояние на стороне сервера. | { "Code": 500, "Message": "Server error." } |
Часто задаваемые вопросы (FAQ)
Как обновить объект списка с помощью API Aspose.Cells Cloud?
Используйте endpoint POST /cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}. Включите в тело запроса JSON с теми свойствами, которые вы хотите изменить (например, DisplayName, ShowHeaderRow). Аутентифицируйтесь с помощью токена JWT в заголовке Authorization.
Какой ответ я получу после успешного обновления?
Возвращается JSON-объект с Code: 200 и Status: "OK". В случае ошибки ответ содержит соответствующий HTTP-код и объект Error с описанием проблемы.
Могу ли я обновить только часть свойств объекта списка?
Да. В теле запроса укажите только те поля, которые хотите изменить; все остальные поля останутся без изменений.
См. также
Семейство облачных SDK
Использование SDK — лучший способ ускорить разработку. SDK обрабатывает низкоуровневые детали, позволяя вам сосредоточиться на задачах проекта. Ознакомьтесь с репозиторием на GitHub, чтобы получить полный список облачных SDK Aspose.Cells Cloud.
Приведённые ниже примеры кода демонстрируют вызов веб-сервисов Aspose.Cells Cloud с использованием различных SDK: