Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
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.
Typical use cases include:
- Retrieving detailed data for a particular entry in a spreadsheet-like application.
- Accessing system or custom fields of a record for further processing or automation.
- Integrating record data into workflows that require up-to-date information from the HAP platform.
For example, you might use this node to get the details of a customer order stored as a record in a worksheet, then use that data to trigger notifications or update other systems.
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 node outputs JSON data representing the requested record's details. This includes all standard fields of the record and, optionally, system fields if requested. The structure typically contains key-value pairs corresponding to each field in the record.
If system fields are included, additional metadata about the record (such as creation date, last modified date, or internal IDs) will be present.
No binary data output is produced by this operation.
Dependencies
- Requires an API key credential for authenticating with the HAP API.
- The node expects network access to the HAP service endpoint.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common Issues:
- Invalid or missing Worksheet ID or Record ID will result in errors or empty responses.
- Insufficient permissions or invalid API credentials can cause authorization failures.
- Network connectivity issues may prevent successful API calls.
Error Messages:
- "Record not found": Verify that the provided Worksheet ID and Record ID are correct and exist.
- "Unauthorized" or "Authentication failed": Check that the API key credential is valid and has necessary permissions.
- "Request timeout" or "Network error": Ensure stable internet connection and that the HAP API endpoint is reachable.
Resolving these usually involves verifying input parameters, checking credential validity, and ensuring network connectivity.