Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Overview
This node interacts with the Hyper Application Platform (HAP) API to retrieve records related to a specific record within a worksheet. The "Get Related" operation under the "Record" resource fetches related records based on a specified related field identifier.
Common scenarios where this node is beneficial include:
- Fetching child or linked records associated with a parent record in a relational data model.
- Retrieving related data entries for reporting or further processing workflows.
- Navigating relationships between records without manually querying multiple endpoints.
For example, if you have a worksheet of "Orders" and each order has related "Order Items," you can use this node to get all items related to a particular order by specifying the order's record ID and the related field that links to the items.
Properties
| Name | Meaning |
|---|---|
| Worksheet ID | The unique identifier of the worksheet containing the record. |
| Record ID | The unique row ID of the record whose related records you want to retrieve. |
| Field | The identifier of the related field that defines the relationship to other records. |
| Page Size | Number of related records to return per page (pagination size). Defaults to 50. |
| Page Index | The page number to retrieve, starting from 1. |
| 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 retrieved from the HAP API. Each item in the output corresponds to a related record, including its fields and values. If the "Return System Fields" option is enabled, system-level metadata fields will also be included.
No binary data output is produced by this operation.
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
- Empty results: Ensure the provided Worksheet ID, Record ID, and Field identifier are correct and that related records exist.
- Authentication errors: Verify that the API key credential is valid and has sufficient permissions.
- Pagination issues: If not all related records appear, adjust the Page Size and Page Index parameters accordingly.
- Invalid Field identifier: Confirm that the related field identifier matches the field configured in the worksheet schema.
Links and References
- Hyper Application Platform (HAP) API Documentation (replace with actual URL)
- n8n documentation on Creating Custom Nodes