HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Record → Get Related

AI-generated

Overview

This node interacts with the Hyper Application Platform (HAP) API to retrieve related records from a specified worksheet record. Specifically, the "Get Related" operation under the "Record" resource fetches records that are related via a particular field of a given record in a worksheet.

Common scenarios where this node is beneficial include:

  • Fetching child or linked records associated with a parent record in relational data models.
  • Retrieving related entries such as comments, attachments, or linked entities connected through a relationship field.
  • Paginating through related records when there are many linked items.

Practical example:

  • In a project management app, you have a "Tasks" worksheet and each task record has related "Comments". Using this node, you can get all comments related to a specific task by specifying the task's record ID and the related field identifier for comments.

Properties

Name Meaning
Worksheet ID The unique identifier of the worksheet containing the record.
Record ID The row ID of the specific record from which to fetch related records.
Field The identifier of the related field that links to other records.
Page Size Number of related records to return per page (pagination size).
Page Index The page number to retrieve, starting from 1 (for pagination).
Return System Fields Boolean flag indicating whether system fields should be included in the returned data.

Output

The node outputs JSON data representing the list of related records fetched from the HAP API. Each item corresponds to a related record linked via the specified field. The structure includes all requested fields of those related records, optionally including system fields if enabled.

If the node supports binary data output (not indicated explicitly here), it would typically represent file attachments or media linked to the records, but this operation primarily returns JSON data about related records.

Dependencies

  • Requires an API key credential for authenticating with the HAP API.
  • The node expects proper configuration of the HAP API credentials within n8n.
  • Network access to the HAP API endpoint is necessary.

Troubleshooting

  • Invalid Worksheet ID or Record ID: If these IDs are incorrect or do not exist, the API will likely return an error or empty results. Verify IDs before running.
  • Incorrect Field Identifier: Specifying a wrong related field may result in no related records found or errors. Confirm the field identifier matches the relation field in the worksheet schema.
  • Pagination Issues: Requesting a page index beyond available pages will return empty results. Adjust page size and index accordingly.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Network or API Downtime: Temporary connectivity issues or API outages will cause failures; retry after some time.

Links and References

Discussion