HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Record → Get

AI-generated

Overview

This node interacts with the HAP (Hyper Application Platform) API to retrieve detailed information about a specific record within a worksheet. The "Get" operation under the "Record" resource fetches the data of a single record identified by its row ID and the worksheet it belongs to.

Common scenarios where this node is beneficial include:

  • Retrieving detailed data for a particular entry in a database or spreadsheet-like structure managed by HAP.
  • Fetching system or user-defined fields of a record for further processing or conditional logic in an automation workflow.
  • Integrating HAP record data into other systems or workflows by extracting precise record details.

Practical example:

  • You have a worksheet tracking customer orders, and you want to get all details of a specific order by its record ID to send a personalized notification or update another system.

Properties

Name Meaning
Worksheet ID The unique identifier of the worksheet containing the record.
Record ID The unique row ID of the record to retrieve.
Include System Fields Whether to include system-generated fields (metadata) in the response (true or false).

Output

The output JSON contains the detailed data of the requested record from the specified worksheet. This includes all user-defined fields and, optionally, system fields if requested.

  • The structure typically mirrors the record's schema in HAP, with key-value pairs representing field names and their values.
  • If "Include System Fields" is enabled, additional metadata fields related to the record's creation, modification, or system status may be included.
  • No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to the HAP API via an API authentication token credential.
  • The node expects proper configuration of this credential within n8n to authenticate requests.
  • Network access to the HAP API endpoint is necessary.

Troubleshooting

  • Missing or invalid Worksheet ID or Record ID: The node requires both IDs to be valid strings. Ensure these are correctly provided; otherwise, the API will return errors indicating missing or invalid identifiers.
  • Authentication errors: If the API key or token is incorrect or expired, the node will fail to authenticate. Verify the credential setup in n8n.
  • Record not found: If the specified record ID does not exist in the given worksheet, the API will return a not found error. Double-check the IDs.
  • API rate limits or connectivity issues: Network problems or hitting API limits can cause failures. Check network connectivity and API usage quotas.

Links and References

Discussion