Apitable icon

Apitable

Interact with Apitable API

Datasheet → Datasheet List

AI-generated

Overview

This node operation, "Datasheet List" under the "Datasheet" resource, interacts with a datasheet management API to list or create datasheets within a specified workspace (space). It allows users to specify details such as the datasheet's name, description, folder location, and field structure. This is useful for automating the organization and creation of datasheets in collaborative environments where structured data tables are managed programmatically.

Practical examples include:

  • Automatically creating new datasheets when a project starts, pre-populated with default or custom fields.
  • Organizing datasheets into specific folders or positions within a workspace.
  • Updating metadata like descriptions or ordering of datasheets based on workflow triggers.

Properties

Name Meaning
Space Id The identifier of the workspace or space where the datasheet resides. Must be selected from available spaces.
Name The name of the datasheet to list or create. Limited to 100 characters.
Description A textual description of the datasheet, up to 500 characters.
Folder Id Identifier of the folder containing the datasheet. If left blank, defaults to the working directory.
Pre Node Id The ID of the previous node; determines the position/order of this datasheet. If empty, it will be placed first.
Fields A list of fields (columns) for the datasheet. If blank, three default columns are added automatically.

Output

The node outputs JSON data representing the datasheet(s) information retrieved or created. This typically includes metadata about each datasheet such as its ID, name, description, folder placement, and field definitions.

If binary data were involved (e.g., file attachments), it would be summarized here, but this operation focuses on JSON metadata only.

Dependencies

  • Requires an API key credential for authenticating with the datasheet service.
  • Needs configuration of the base URL for the API endpoint.
  • Utilizes dynamic loading of options for properties like "Space Id" via internal methods that fetch available spaces.

Troubleshooting

  • Missing or invalid Space Id: Ensure the space ID is correctly selected from the available options. An incorrect or missing space ID will cause API errors.
  • Name length exceeded: The datasheet name must not exceed 100 characters; otherwise, the API may reject the request.
  • Description length exceeded: Descriptions longer than 500 characters might cause errors.
  • Folder Id issues: Providing an invalid folder ID may result in the datasheet being created in an unintended location or cause failure.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Empty fields property: If no fields are specified, the system adds three default columns; ensure this behavior aligns with your needs.

Common error messages will relate to validation failures on these properties or authentication problems. Resolving them involves correcting input values or updating credentials.

Links and References

Discussion