HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Record → Get Share Link

AI-generated

Overview

This node interacts with the HAP (Hyper Application Platform) API to generate a shareable link for a specific record within a worksheet. The "Get Share Link" operation under the "Record" resource allows users to create a URL that can be shared externally, providing controlled access to a particular record.

Common scenarios where this node is beneficial include:

  • Sharing a single record's data with external collaborators without giving full access to the entire dataset.
  • Generating temporary or permanent links for customer support or review purposes.
  • Restricting visible fields and securing access via password protection on shared records.

For example, a user might want to share a sales record with a client by generating a link valid for 24 hours, showing only relevant fields, and protected by a password.

Properties

Name Meaning
Worksheet ID The unique identifier of the worksheet containing the record.
Record ID The unique row ID of the record to share.
Expired In (Seconds) Duration in seconds for which the share link remains valid; 0 means the link never expires.
Visible Fields JSON array specifying which field IDs should be visible when accessing the share link.
Password Optional password required to access the shared record; leave empty for no password protection.

Output

The node outputs a JSON object containing the generated share link information. This typically includes the URL that can be used to access the shared record with the specified visibility and security settings.

If the node supports binary data output (not indicated here), it would represent any file or media associated with the record, but in this case, the output is focused on JSON data representing the share link.

Dependencies

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

Troubleshooting

  • Invalid Worksheet or Record ID: If the provided worksheet or record ID does not exist or is incorrect, the API will likely return an error. Verify IDs before running the node.
  • ExpiredIn Value Issues: Setting a negative expiration time or invalid number may cause errors. Use 0 for permanent links or a positive integer for expiry.
  • Password Restrictions: Using unsupported characters or exceeding length limits in the password may cause failures.
  • API Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Empty Visible Fields Array: If no fields are specified as visible, the resulting share link might show no data or cause an error. Provide at least one field ID if restricting visibility.

Links and References

Discussion