Cloud-based Excel File Management Solution – Interface for Quickly Getting File List in the Cloud

Excel API: Get Files List

The Get Files List operation returns the collection of files and sub‑folders stored in a specified folder. For an overview of all storage‑related operations, see the Files and Storage page.

Web API

GET https://api.aspose.cloud/v4.0/cells/storage/folder/{path}

Sample request (cURL)

curl -X GET "https://api.aspose.cloud/v4.0/cells/storage/folder/{path}?storageName=MyStorage&pageSize=100&pageNumber=1" \
     -H "Authorization: Bearer <your_access_token>"

Function Description

The getFilesList API retrieves a comprehensive list of files and folders contained within a specified directory in Aspose.Cells Cloud storage. This endpoint is essential for efficient file management and supports a variety of Excel‑related file formats.

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

-H "Authorization: Bearer {access_token}"

Request Parameters for Get Files List API

Parameter Name Type Location Description
path String Path The path to the folder in cloud storage from which the file list is retrieved.
storageName String Query (Optional) The name of the storage to access.
pageSize Integer Query (Optional) Maximum number of items to return per page.
pageNumber Integer Query (Optional) Page number to retrieve (starting at 1).

Response Description

{
  "Name": "FilesList",
  "Description": ["Files list"],
  "Type": "Class",
  "IsAbstract": false,
  "Properties": [
    {
      "Name": "Value",
      "Description": [
        "Files and folders contained by the specified StorageFile."
      ],
      "Nullable": true,
      "ReadOnly": false,
      "IsInherit": false,
      "DataType": {
        "Identifier": "Container",
        "Reference": "StorageFile",
        "ElementDataType": {
          "Identifier": "Class",
          "Reference": "StorageFile",
          "Name": "class:storagefile"
        },
        "Name": "container"
      }
    }
  ]
}

Sample successful response

{
  "Value": [
    {
      "Name": "Report.xlsx",
      "IsFolder": false,
      "Size": 124578,
      "ModifiedDate": "2024-03-10T12:34:56Z"
    },
    {
      "Name": "Archives",
      "IsFolder": true,
      "Size": 0,
      "ModifiedDate": "2024-02-01T08:00:00Z"
    }
  ]
}

Common Error Responses

Status Code Meaning Response Body (example)
200 Successful retrieval. { "Value": [ … ] }
400 Invalid parameters. { "Code": 400, "Message": "Invalid request." }
401 Missing or invalid token. { "Code": 401, "Message": "Authentication failed." }
404 Specified folder does not exist. { "Code": 404, "Message": "Folder not found." }
500 Server‑side problem. { "Code": 500, "Message": "Unexpected error." }

OpenAPI Specification

The OpenAPI Specification defines a publicly accessible programming interface that enables REST interactions directly from a web browser, facilitating easy integration and testing.

Excel API SDK

Utilizing an SDK is the optimal approach to accelerate your development process. An SDK manages low‑level details, allowing you to concentrate on your project tasks. For a complete list of Aspose.Cells Cloud SDKs, please visit the GitHub repository.

The following code examples illustrate how to invoke Aspose.Cells web services using various SDKs: