Apitable icon

Apitable

Interact with Apitable API

Actions11

Node → Node List

AI-generated

Overview

This node interacts with the Apitable API to list file nodes within a specified workspace (called "Space" in Apitable). It allows users to retrieve a filtered list of nodes such as folders, datasheets, forms, dashboards, or mirrors based on various criteria like type, permissions, and search query.

Common scenarios where this node is beneficial include:

  • Automating retrieval of specific types of files or folders from a collaborative workspace.
  • Filtering nodes by user permissions to display only accessible resources.
  • Searching for nodes by partial names to dynamically find relevant data sources.

For example, a user might use this node to list all datasheets they have editor access to within a particular space, or to find all dashboards containing a certain keyword.

Properties

Name Meaning
Space Id The unique identifier of the workspace ("Space") from which to list nodes. This is required.
Additional Fields Optional filters and parameters to refine the node listing:
- Type: Filter nodes by their type. Options are Folder, Datasheet, Form, Dashboard, Mirror (case-sensitive).
- Permissions: Filter nodes by permission level:
0: Manager
1: Editor
2: Update-only
3: Read-only
4: (unspecified)
- Query: Search keyword to filter nodes by partial name matches.

Output

The node outputs a JSON array of file nodes matching the specified criteria. Each item in the output represents a file node with its associated metadata as returned by the Apitable API.

If the node supports binary data output, it would typically represent file contents or attachments, but based on the provided code and properties, the output focuses on JSON metadata about nodes.

Dependencies

  • Requires an API key credential for authenticating with the Apitable API.
  • Needs the base URL of the Apitable instance configured in credentials.
  • Uses internal methods to load options dynamically for spaces, datasheets, and views.
  • Depends on the Apitable API endpoint /fusion/v1 for requests.

Troubleshooting

  • Invalid Space Id: If the Space Id is incorrect or inaccessible, the node will fail to retrieve nodes. Verify the Space Id exists and the API token has access.
  • Permission Filters Not Working: Ensure the permission values used are valid and correspond to the user's actual permissions.
  • Empty Results: Could be due to no nodes matching the filters or insufficient permissions. Try broadening filters or checking API token scopes.
  • API Authentication Errors: Confirm that the API key credential is correctly set up and has not expired or been revoked.
  • Case Sensitivity in Type: The type filter is case-sensitive; using incorrect casing will result in no matches.

Links and References

Discussion