Caspio icon

Caspio

Interact with Caspio REST API.
Join our community

Actions21

Overview

This node interacts with the Caspio REST API to retrieve folder properties within the File resource. It supports two modes: Basic, which provides a visual interface for selecting a parent folder and sorting options; and Advanced, which allows direct input of API parameters for complex queries. The node can list subfolders from a specified parent folder, optionally including all subfolders recursively, and supports sorting by name or creation date in ascending or descending order. This is useful for automating file management tasks, such as organizing folders or retrieving folder metadata in Caspio applications.

Use Case Examples

  1. Retrieve all subfolders under a specific parent folder to generate a folder structure report.
  2. List folders sorted by creation date to monitor recent additions.
  3. Use advanced mode to perform complex folder queries with pagination and custom sorting.

Properties

Name Meaning
Mode Choose the interface complexity level between Basic and Advanced modes.
Parent Folder Select the parent folder to list subfolders from (Basic mode only). Can be specified by path or external key.
Include Subfolders Whether to recursively list folders from all subfolders (Basic mode only). Note that sorting is disabled when this is enabled.
Sort By Field to sort folders by (Basic mode only, when not including subfolders).
Sort Order Sort order for the folders (Basic mode only, when not including subfolders).
Parent Folder External Key External key of the parent folder to list subfolders from (Advanced mode only).
Sort Field Field to sort folders by (Advanced mode only). Leave empty for default.
Sort Descending Whether to sort in descending order (Advanced mode only).
Page Number Page number for pagination, starting at 1 (Advanced mode only).
Page Size Number of records per page, between 5 and 1000 (Advanced mode only).

Output

JSON

  • folders - Array of folder objects with their properties such as name, creation date, and external key.
  • parentFolder - Information about the parent folder from which subfolders were listed.
  • pagination - Pagination details when using advanced mode, including page number and size.

Dependencies

  • Caspio REST API

Troubleshooting

  • Ensure the API credentials are correctly configured and authorized to access the Caspio File resource.
  • When using Basic mode, verify that the parent folder path or external key is valid and accessible.
  • If including subfolders recursively, be aware that sorting is disabled and multiple API calls are made, which may affect performance.
  • In Advanced mode, ensure that pagination parameters are within allowed ranges (page size between 5 and 1000).
  • Common errors may include authentication failures, invalid folder identifiers, or exceeding API rate limits. Check API response messages for specific guidance.

Links

Discussion