HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Worksheet → Get Structure

AI-generated

Overview

This node interacts with the HAP (Hyper Application Platform) API to retrieve the structure of a specific worksheet. It is useful when you need to understand or manipulate the schema, fields, or configuration of a worksheet within the HAP system. For example, you might use this node to fetch the layout and metadata of a worksheet before importing data into it or generating reports based on its structure.

Properties

Name Meaning
Worksheet ID The ID of the worksheet to get the structure for

Output

The node outputs JSON data representing the structure of the specified worksheet. This typically includes details such as field definitions, data types, layout information, and other configuration metadata that define how the worksheet is organized and behaves within the HAP platform.

No binary data output is indicated.

Dependencies

  • Requires an API key credential to authenticate with the HAP API.
  • The node expects the HAP API to be accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing Worksheet ID: Ensure the Worksheet ID provided is correct and exists in the HAP system.
    • Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
    • Network or API availability problems: Check connectivity to the HAP API endpoint.
  • Error messages:

    • "Worksheet not found" — indicates the Worksheet ID does not exist; verify the ID.
    • "Unauthorized" or "Authentication failed" — check API credentials.
    • Timeout or connection errors — ensure network access and API service status.

Links and References

Discussion