Documentation –

Developer-Guide: Aspose.Cells Cloud API – 从工作表获取列表对象（表格）

Mon, 01 Jan 0001 00:00:00 +0000

Aspose.Cells Cloud API – 从工作表获取列表对象（表格）

从 Excel 工作簿中的特定工作表中检索列表对象（也称为表格）。通过使用可选的 format 查询参数，该端点还可将表格直接导出为指定格式。

前提条件

要求	详情
身份验证	需要有效的 JWT（Bearer）令牌。可通过身份验证指南中所述的 OAuth2 身份验证流程获取令牌。
存储	工作簿必须存储在 Aspose Cloud 存储位置中。若文件位于非默认存储中，请指定 `storageName` 查询参数。
速率限制	该 API 遵循标准的 Aspose Cloud 速率限制策略（默认为每个账户每分钟 100 次请求）。
SDK（可选）	使用官方 SDK（C#、Java、Python 等）可简化请求构建与响应处理。请参见下方的 SDK 示例部分。

请求

HTTP GET

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

参数	类型	位置	必填	描述
name	`string`	路径	✔️	Excel 文件名称（含扩展名）。
sheetName	`string`	路径	✔️	包含列表对象的工作表名称。
listobjectindex	`integer`	路径	✔️	要检索的列表对象的从零开始的索引。
format	`string`	查询参数	❌	目标导出格式（如 `pdf`、`csv`、`json`）。
folder	`string`	查询参数	❌	工作簿所在文件夹路径。
storageName	`string`	查询参数	❌	要使用的 Aspose Cloud 存储名称。

说明

所有调用必须通过 HTTPS 发起。
若提供 format 参数，响应体即为导出的文件流（如 application/pdf）。
若未提供 format，API 将返回 ListObject 的 JSON 描述。

cURL 示例

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/listobjects/1?format=csv" \
  -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <your_jwt_token>"

请将 <your_jwt_token> 替换为从身份验证端点获取的有效 JWT。

成功响应（JSON）

当省略 format 时，API 返回一个描述 ListObject 的 JSON 负载。

{
  "ListObject": {
    "AutoFilter": {
      "FilterColumns": [],
      "Range": "B2:F11",
      "Sorter": {
        "CaseSensitive": false,
        "HasHeaders": false,
        "KeyList": [],
        "SortLeftToRight": false
      }
    },
    "DisplayName": "Table3",
    "StartColumn": 1,
    "StartRow": 1,
    "EndColumn": 5,
    "EndRow": 10,
    "ListColumns": [
      {
        "Name": "Column1",
        "Range": {
          "ColumnCount": 1,
          "ColumnWidth": 8.5,
          "FirstColumn": 1,
          "FirstRow": 1,
          "RefersTo": "=Sheet1!$B$2:$B$11",
          "RowCount": 10,
          "RowHeight": 13.5,
          "Worksheet": "Sheet1"
        },
        "TotalsCalculation": "None"
      },
      {
        "Name": "Column2",
        "Range": {
          "ColumnCount": 1,
          "ColumnWidth": 8.5,
          "FirstColumn": 2,
          "FirstRow": 1,
          "RefersTo": "=Sheet1!$C$2:$C$11",
          "RowCount": 10,
          "RowHeight": 13.5,
          "Worksheet": "Sheet1"
        },
        "TotalsCalculation": "None"
      },
      {
        "Name": "Column3",
        "Range": {
          "ColumnCount": 1,
          "ColumnWidth": 8.5,
          "FirstColumn": 3,
          "FirstRow": 1,
          "RefersTo": "=Sheet1!$D$2:$D$11",
          "RowCount": 10,
          "RowHeight": 13.5,
          "Worksheet": "Sheet1"
        },
        "TotalsCalculation": "None"
      },
      {
        "Name": "Column4",
        "Range": {
          "ColumnCount": 1,
          "ColumnWidth": 8.5,
          "FirstColumn": 4,
          "FirstRow": 1,
          "RefersTo": "=Sheet1!$E$2:$E$11",
          "RowCount": 10,
          "RowHeight": 13.5,
          "Worksheet": "Sheet1"
        },
        "TotalsCalculation": "None"
      },
      {
        "Name": "Column5",
        "Range": {
          "ColumnCount": 1,
          "ColumnWidth": 8.5,
          "FirstColumn": 5,
          "FirstRow": 1,
          "RefersTo": "=Sheet1!$F$2:$F$11",
          "RowCount": 10,
          "RowHeight": 13.5,
          "Worksheet": "Sheet1"
        },
        "TotalsCalculation": "None"
      }
    ],
    "ShowHeaderRow": true,
    "ShowTableStyleColumnStripes": false,
    "ShowTableStyleFirstColumn": false,
    "ShowTableStyleLastColumn": false,
    "ShowTableStyleRowStripes": true,
    "ShowTotals": false,
    "TableStyleName": "None",
    "TableStyleType": "None",
    "link": {
      "Href": "api-qa.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/listobjects/0",
      "Rel": "self"
    }
  },
  "Code": 200,
  "Status": "OK"
}

当提供 format 参数时，响应体即为所请求文件类型的二进制流（例如 Content-Type: text/csv）。

错误处理

HTTP 状态码	含义	示例 JSON
400	请求错误 — 缺少或无效参数。	`{"Code":400,"Message":"Invalid format parameter."}`
401	未授权 — 缺少或无效 JWT 令牌。	`{"Code":401,"Message":"Authentication failed."}`
404	未找到 — 工作簿、工作表或列表对象不存在。	`{"Code":404,"Message":"ListObject not found."}`
500	服务器内部错误。	`{"Code":500,"Message":"Unexpected server error."}`

常见问题（注意事项）

从零开始的索引 — listobjectindex 从 0 开始计数。请求索引 1 将返回工作表中的第二个表格。
文件夹与存储 — 若工作簿存储在子文件夹中，请包含 folder 查询参数（例如 ?folder=Reports/2024）。
导出格式 — 仅允许使用 Aspose.Cells 转换引擎支持的格式（如 pdf、xlsx、csv、json 等）。提供不支持的值将触发 400 错误。

SDK 示例

以下代码片段演示如何使用官方 Aspose.Cells Cloud SDK 调用该端点。请将占位符（如 <YOUR_CLIENT>、<YOUR_JWT> 等）替换为您的实际配置。

💻 C#

using Aspose.Cells.Cloud.SDK.Api;
using Aspose.Cells.Cloud.SDK.Model.Requests;

// 初始化 API 客户端
var apiInstance = new ListObjectsApi();

// 构建请求
var request = new GetWorksheetListObjectRequest(
    name: "Book1.xlsx",
    sheetName: "Sheet1",
    listobjectindex: 1,
    format: null,               // 例如 "csv" 用于导出
    folder: null,
    storageName: null
);

// 执行请求
var response = apiInstance.GetWorksheetListObject(request);
Console.WriteLine(response);

☕ Java

import com.aspose.cells.cloud.api.ListObjectsApi;
import com.aspose.cells.cloud.model.*;
import com.aspose.cells.cloud.model.requests.*;

public class GetWorksheetListObjectExample {
    public static void main(String[] args) throws ApiException {
        ListObjectsApi apiInstance = new ListObjectsApi();

        GetWorksheetListObjectRequest request = new GetWorksheetListObjectRequest(
                "Book1.xlsx",   // name
                "Sheet1",       // sheetName
                1,              // listobjectindex
                null,           // format
                null,           // folder
                null            // storageName
        );

        ListObjectResponse result = apiInstance.getWorksheetListObject(request);
        System.out.println(result);
    }
}

🐍 Python

from asposecellscloud.apis.list_objects_api import ListObjectsApi
from asposecellscloud.models import GetWorksheetListObjectRequest

api = ListObjectsApi()

request = GetWorksheetListObjectRequest(
    name="Book1.xlsx",
    sheet_name="Sheet1",
    listobjectindex=1,
    format=None,
    folder=None,
    storage_name=None
)

response = api.get_worksheet_list_object(request)
print(response)

🟢 Node.js (TypeScript)

import { ListObjectsApi, GetWorksheetListObjectRequest } from "@asposecellscloud/asposecellscloud";

const api = new ListObjectsApi();

const request = new GetWorksheetListObjectRequest({
    name: "Book1.xlsx",
    sheetName: "Sheet1",
    listobjectindex: 1,
    format: undefined,
    folder: undefined,
    storageName: undefined
});

api.getWorksheetListObject(request)
   .then(response => console.log(response))
   .catch(err => console.error(err));

🐘 PHP

<?php
require_once(__DIR__ . '/vendor/autoload.php');

use Aspose\Cells\Cloud\Api\ListObjectsApi;
use Aspose\Cells\Cloud\Model\Requests\GetWorksheetListObjectRequest;

$listObjectsApi = new ListObjectsApi();

$request = new GetWorksheetListObjectRequest(
    "Book1.xlsx",   // name
    "Sheet1",       // sheetName
    1,              // listobjectindex
    null,           // format
    null,           // folder
    null            // storageName
);

$response = $listObjectsApi->getWorksheetListObject($request);
print_r($response);
?>

💎 Ruby

require 'aspose_cells_cloud'

api_instance = AsposeCellsCloud::ListObjectsApi.new

request = AsposeCellsCloud::GetWorksheetListObjectRequest.new(
  name: 'Book1.xlsx',
  sheet_name: 'Sheet1',
  listobjectindex: 1,
  format: nil,
  folder: nil,
  storage_name: nil
)

result = api_instance.get_worksheet_list_object(request)
puts result

🦪 Go

package main

import (
    "fmt"
    cells "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v3"
    "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v3/api"
)

func main() {
    cfg := cells.NewConfiguration()
    cfg.AddDefaultHeader("Authorization", "Bearer <your_jwt>")
    client := api.NewAPIClient(cfg)

    request := api.GetWorksheetListObjectRequest{
        Name:            "Book1.xlsx",
        SheetName:       "Sheet1",
        Listobjectindex: 1,
        Format:          nil,
        Folder:          nil,
        StorageName:     nil,
    }

    result, _, err := client.ListObjectsApi.GetWorksheetListObject(request)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Printf("%+v\n", result)
}

参考链接

相关端点	描述
添加 ListObject	`POST /cells/{name}/worksheets/{sheetName}/listobjects` — 创建新表格。
更新 ListObject	`PUT /cells/{name}/worksheets/{sheetName}/listobjects/{listobjectindex}` — 修改表格属性。
删除 ListObject	`DELETE /cells/{name}/worksheets/{sheetName}/listobjects/{listobjectindex}` — 删除表格。
列出所有 ListObjects	`GET /cells/{name}/worksheets/{sheetName}/listobjects` — 枚举工作表中的表格。

参考资料

OpenAPI 规范 — https://apireference.aspose.cloud/cells/#/ListObjects/GetWorksheetListObject
身份验证指南 — https://docs.aspose.cloud/cells/authentication/
GitHub 仓库（SDK） — https://github.com/aspose-cells-cloud

Developer-Guide: 向 Excel 工作表添加列表对象（表格）

Mon, 01 Jan 0001 00:00:00 +0000

此 REST API 可向 Excel 工作表添加列表对象（表格）。

在使用此端点前，请确保您已获取有效的 JWT 令牌、工作簿存储在受支持的云存储中，且目标工作表已存在。

REST API

PUT https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects

请求参数

参数名称	类型	位置	描述
name	string	路径	工作簿文件名。
sheetName	string	路径	工作表名称。
startRow	integer	查询	表格区域首行的从零开始索引。
startColumn	integer	查询	表格区域首列的从零开始索引。
endRow	integer	查询	表格区域末行的从零开始索引。
endColumn	integer	查询	表格区域末列的从零开始索引。
hasHeaders	boolean	查询	若首行包含列标题则为 `true`，否则为 `false`。
listObject	object	请求体	列表对象定义（详见请求体架构）。
folder	string	查询	包含工作簿的文件夹。
storageName	string	查询	存储名称。

请求体架构

listObject 对象描述将创建的表格。仅列出最常用属性；完整属性列表请参阅 OpenAPI 规范。

{
  "displayName": "MyTable",
  "showTotals": false,
  "style": "TableStyleMedium2"
}

示例请求（cURL）

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/listobjects?startRow=1&startColumn=1&endRow=10&endColumn=12&hasHeaders=true" \
  -X PUT \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{
        "displayName": "MyTable",
        "showTotals": false,
        "style": "TableStyleMedium2"
      }'

示例响应

{
  "Code": 200,
  "Status": "OK"
}

错误代码

HTTP 状态码	原因	描述
400	错误请求	范围参数无效或 JSON 请求体格式错误。
401	未授权	缺失或已过期的 JWT 令牌。
404	未找到	指定的工作簿或工作表不存在。
500	内部服务器错误	服务器端意外错误。

示例 400 响应

{
  "Code": 400,
  "Status": "Bad Request",
  "Message": "Invalid range parameters."
}

示例 401 响应

{
  "Code": 401,
  "Status": "Unauthorized",
  "Message": "Authentication token is missing or expired."
}

OpenAPI 规范提供了此操作的完整接口定义。

云 SDK 家族

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

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

Developer-Guide: 从 ListObject 中删除重复行 - Aspose.Cells Cloud API 文档

Mon, 01 Jan 0001 00:00:00 +0000

此 REST API 可用于删除 Excel 工作表中 ListObject 的重复行。

REST API

POST https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/RemoveDuplicates

请求参数

参数名称	类型	位置	描述
name	字符串	路径	Excel 文件的名称。
sheetName	字符串	路径	包含列表对象的工作表名称。
listObjectIndex	整数	路径	要处理的列表对象的从零开始的索引。
folder	字符串	查询	（可选）文件所在的文件夹路径。
storageName	字符串	查询	（可选）存储服务的名称。

示例请求（cURL）

请求

curl -v "https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/RemoveDuplicates" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

响应

{
  "Code": 200,
  "Status": "OK",
  "DuplicateRowsRemoved": 12,
  "Message": "重复行已成功删除。"
}

响应

成功时，服务将返回类似上述示例的 JSON 对象。各字段含义如下：

Code – HTTP 状态码（成功时为 200）。
Status – 状态的文字描述。
DuplicateRowsRemoved – 已删除的行数。
Message – 关于此操作的附加信息。

HTTP 状态码

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

云 SDK 家族

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

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

Developer-Guide: 向 Excel ListObject 插入切片器 – Aspose.Cells Cloud API

Mon, 01 Jan 0001 00:00:00 +0000

此 REST API 用于在 Excel 工作表的列表对象上插入切片器。

REST API

POST https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/InsertSlicer

请求参数

参数名称	类型	位置	描述
name	String	Path	Excel 文件的名称。
sheetName	String	Path	包含列表对象的工作表名称。
listObjectIndex	Integer	Path	将添加切片器的列表对象的从零开始的索引。
columnIndex	Integer	Query	切片器所依据的列的从零开始的索引。
destCellName	String	Query	切片器放置位置的单元格引用（例如 A1）。
folder	String	Query	存储中包含 Excel 文件的文件夹。
storageName	String	Query	Aspose Cloud 存储服务的名称。

您可以使用 cURL 命令行工具调用该 API：

请求

curl -v "https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/InsertSlicer" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

注意： 此请求需要从 Aspose Cloud 身份验证服务获取的有效 JWT bearer token。此端点无需请求体；如果您的客户端库强制要求提供载荷，请发送一个空 JSON 对象 {}。

响应

{
  "Code": 200,
  "Status": "OK",
  "Slicer": {
    "Name": "Slicer1",
    "ColumnIndex": 2,
    "Position": "A1"
  }
}

响应头： Content-Type: application/json

HTTP 状态码

状态码	含义	描述
200	OK（成功）	过滤器应用成功；响应包含操作详情。
400	Bad Request（错误请求）	缺少或无效参数（例如，不支持的文件类型）。
401	Unauthorized（未授权）	JWT token 无效或缺失。
413	Payload Too Large（载荷过大）	上传文件超过大小限制。
500	Internal Server Error（内部服务器错误）	服务器发生意外错误。

错误处理

当发生错误时，API 将返回一个包含 ErrorMessage 字段的 JSON 对象，用于描述问题。请检查 HTTP 状态码和 ErrorMessage 字段以确定应采取的修正措施。

云 SDK 家族

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

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

Developer-Guide: 更新 Excel 工作表中的列表对象

Mon, 01 Jan 0001 00:00:00 +0000

此 REST API 可用于更新 Excel 工作表中列表对象（表格）的属性。

安全性与身份验证

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

请求体结构

listObject 数据传输对象（DTO）包含以下字段。请求体中仅需包含您希望修改的字段。

字段	类型	是否必需	描述
DisplayName	字符串（string）	可选	表格的显示名称。
StartRow / StartColumn	整数（integer）	可选	表格起始行/列的从零开始索引。
EndRow / EndColumn	整数（integer）	可选	表格末尾行/列的从零开始索引。
Range	字符串（string）	可选	以 A1 样式表示的地址，定义表格范围（例如：`A1:D10`）。
ShowHeaderRow	布尔值（boolean）	可选	为 `true` 时显示标题行。
ShowTotals	布尔值（boolean）	可选	为 `true` 时显示总计行。
TableStyleName	字符串（string）	可选	要应用的内置表格样式名称。
TableStyleType	字符串（string）	可选	样式类型（如 `TableStyleLight`、`TableStyleMedium` 等）。
ListColumns	对象数组（array）	可选	列定义集合（包含 `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	字符串	路径	文档名称。
sheetName	字符串	路径	工作表名称。
listObjectIndex	整数	路径	要更新的列表对象索引。
listObject	对象	请求体	请求体中的 ListObject DTO 对象。
folder	字符串	查询	包含该文档的文件夹。
storageName	字符串	查询	存储空间名称。

OpenAPI 规范定义了一个公开可用的编程接口，您可直接在网页浏览器中发起 REST 调用。

请求

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet7/listobjects/0" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{
    "DisplayName": "SalesData",
    "Range": "A1:E20",
    "ShowHeaderRow": true,
    "ShowTotals": false,
    "ListColumns": [
      { "Name": "Product", "TotalsCalculation": "None" },
      { "Name": "Quantity", "TotalsCalculation": "Sum" },
      { "Name": "Price", "TotalsCalculation": "Average" }
    ]
  }'

响应

{
  "Code": 200,
  "Status": "OK"
}

成功响应包含以下字段：

字段	类型	描述
Code	整数	HTTP 状态码（200 表示成功）。
Status	字符串	状态的文本描述。
UpdatedObject （可选）	对象	更新后的 `ListObject` 表示，包含已修改的字段。

错误响应

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）

如何使用 Aspose.Cells Cloud API 更新列表对象？

调用 POST /cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex} 端点。在请求体中包含您希望修改的属性（如 DisplayName、ShowHeaderRow），并在 Authorization 请求头中提供 JWT 令牌进行身份验证。

更新成功后，我将收到什么响应？

返回包含 Code: 200 和 Status: "OK" 的 JSON 对象。若发生错误，响应将包含对应的 HTTP 状态码及描述问题的 Error 对象。

是否可以仅更新列表对象的部分属性？

可以。请求体中仅需包含您希望修改的字段；所有省略字段将保持不变。

云 SDK 家族

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

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

Developer-Guide: 将列表对象转换为区域——Aspose.Cells Cloud API

Mon, 01 Jan 0001 00:00:00 +0000

此 REST API 可将 Excel 工作表中的 ListObject（表格） 转换为 区域（Range）。

前置条件：
调用端点前，请确保：

工作簿已上传至您的 Aspose Cloud 存储空间；
工作表中包含目标 ListObject；
使用受支持的文件格式（例如 .xlsx、.xlsm）。

REST API

身份验证
调用此操作时，必须在 Authorization 请求头中包含有效的 JWT 令牌。您可通过向 OAuth 2.0 令牌端点发送 POST 请求（附带您的客户端 ID 和客户端密钥）来获取该令牌。该令牌必须包含 Cells.ReadWrite 作用域，并在令牌服务返回的有效期内有效。

POST https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/ConvertToRange

安全与身份验证

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

请求参数

参数名称	类型	位置	是否必填	默认值	描述
name	string	路径	是	–	Excel 文件的名称。
sheetName	string	路径	是	–	包含 ListObject 的工作表名称。
listObjectIndex	integer	路径	是	–	待转换 ListObject（表格）的从零开始索引。
folder	string	查询	否	–	文件所在文件夹的路径。
storageName	string	查询	否	–	存储服务的名称。

注意： 此操作仅适用于现代 Excel 格式，如 .xlsx 和 .xlsm。ListObject 不得受保护。有关 ListObjects 的更多信息，请参阅 ListObjects 概述；有关区域操作的详细说明，请参阅区域文档。

cURL 示例（请求）

请求

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/listobjects/0/ConvertToRange" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <your-jwt-token>"

响应

{
  "Code": 200,
  "Status": "OK",
  "RangeName": "A1:C10",
  "Address": "Sheet1!A1:C10",
  "FirstRow": 0,
  "FirstColumn": 0,
  "RowCount": 10,
  "ColumnCount": 3
}

云 SDK 开发工具包

使用 SDK 是加快开发速度的最佳方式。SDK 负责处理底层细节，使您能专注于项目核心任务。请查看 GitHub 仓库，了解 Aspose.Cells Cloud SDK 的完整列表。

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

Developer-Guide: 对 Excel 工作表中的 ListObject 数据进行排序

Mon, 01 Jan 0001 00:00:00 +0000

前置条件
要调用此 API，您必须拥有有效的 Aspose Cloud JWT 访问令牌，并且工作簿必须已上传至 Aspose Cloud 存储空间。请在每个请求中包含请求头 Authorization: Bearer <jwt token>。

此 REST API 用于对 Excel 工作表中表格的数据进行排序。
要使用该操作，请提供工作簿名称、工作表名称以及目标 ListObject 的索引，并附带一个定义排序条件的 dataSorter JSON 请求体。

PostWorksheetListObjectSortTable API

POST https://api.aspose.cloud/v3.0/cells/{name}/worksheets/{sheetName}/listobjects/{listObjectIndex}/sort

安全与身份验证

Aspose.Cells Cloud API 是安全的，需要基于 JWT 令牌的身份验证。

请求参数

参数名称	类型	路径/查询字符串/HTTP 请求体	描述
name	string	path	存储在 Aspose Cloud 存储空间中的 Excel 文件名称。
sheetName	string	path	包含 ListObject 的工作表名称。
listObjectIndex	integer	path	工作表内 ListObject（表格）的从零开始的索引。
dataSorter	object	body	指定排序选项的 JSON 对象（例如：`CaseSensitive`、`HasHeaders`、`KeyList`、`SortLeftToRight`）。
folder	string	query	存储空间中 Excel 文件所在的文件夹路径。
storageName	string	query	Aspose Cloud 存储空间的名称。

注意事项
请求体必须是符合 dataSorter 模式的有效 JSON 对象。在调用排序操作前，请确保工作簿、工作表和 ListObject 均已存在。

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

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

请求

curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/sheet7/listobjects/1/sort" \
  -X POST \
  -d '{
        "CaseSensitive": true,
        "HasHeaders": true,
        "KeyList": [
          {
            "Key": 1,
            "SortOrder": "Ascending",
            "CustomList": "string"
          }
        ],
        "SortLeftToRight": true
      }' \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

响应

{
  "Code": 200,
  "Status": "OK"
}

HTTP 状态码

状态码	描述
200	OK（成功）——排序已完成。
400	Bad Request（错误请求）——参数无效。
401	Unauthorized（未授权）——身份验证失败。
404	Not Found（未找到）——工作簿、工作表或 ListObject 不存在。
500	Internal Server Error（内部服务器错误）——服务端问题。

响应参数

参数名	类型	描述
Code	integer	API 返回的 HTTP 状态码。
Status	string	结果的文本描述（例如：“OK”）。

云 SDK 开发工具包

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

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

返回 ListObjects 概述

Documentation –

Developer-Guide: Aspose.Cells Cloud API – 从工作表获取列表对象（表格）

Aspose.Cells Cloud API – 从工作表获取列表对象（表格）

前提条件

请求

HTTP GET

说明

cURL 示例

成功响应（JSON）

错误处理

常见问题（注意事项）

SDK 示例

参考链接

参考资料

Developer-Guide: 向 Excel 工作表添加列表对象（表格）

REST API

请求参数

请求体架构

示例请求（cURL）

示例响应

错误代码

云 SDK 家族

Developer-Guide: 从 ListObject 中删除重复行 - Aspose.Cells Cloud API 文档

REST API

请求参数

示例请求（cURL）

响应

云 SDK 家族

Developer-Guide: 向 Excel ListObject 插入切片器 – Aspose.Cells Cloud API

REST API

请求参数

错误处理

云 SDK 家族

Developer-Guide: 更新 Excel 工作表中的列表对象

安全性与身份验证

请求体结构

最小示例请求体

REST API

请求参数

请求

错误响应

常见问题（FAQ）

相关文档

云 SDK 家族

Developer-Guide: 将列表对象转换为区域——Aspose.Cells Cloud API

REST API

安全与身份验证

请求参数

cURL 示例（请求）

云 SDK 开发工具包

Developer-Guide: 对 Excel 工作表中的 ListObject 数据进行排序

PostWorksheetListObjectSortTable API

安全与身份验证

请求参数

云 SDK 开发工具包

HTTP GET