Actions31
- Option Set Actions
- Public Query Actions
- Record Actions
- Role Actions
- Workflow Actions
- Worksheet Actions
Overview
This node operation retrieves discussions (comments and system messages) related to a specific record in a worksheet within the Hyper Application Platform (HAP). It is useful for scenarios where you want to programmatically access conversation threads, feedback, or audit trail messages attached to a particular data record. For example, you might use this node to fetch all comments on a customer support ticket or to review system-generated messages linked to a sales order.
Properties
| Name | Meaning |
|---|---|
| Worksheet ID | The unique identifier of the worksheet containing the record. |
| Record ID | The unique row ID of the record whose discussions are to be retrieved. |
| Page Size | Number of discussion entries to return per page (pagination size). |
| Page Index | The page number to retrieve, starting from 1. |
| Sort Type | The order in which discussions are sorted: "Latest First" or "Oldest First". |
| Discussion Type | Filter by type of discussions: "All", "Comments" only, or "System Messages" only. |
| Search | A search term to filter discussions by content. |
| Only With Attachments | Whether to return only discussions that include attachments (true/false). |
Output
The output JSON contains an array of discussion objects related to the specified record. Each discussion entry typically includes details such as the message content, author, timestamp, type (comment or system message), and any associated attachments. If the "Only With Attachments" option is enabled, only discussions containing attachments will be included.
If the node supports binary data, it would relate to attachments within discussions, but based on the provided code and properties, the main output is structured JSON data representing discussions.
Dependencies
- Requires an API key credential to authenticate with the HAP API.
- The node depends on the HAP API service being accessible and properly configured.
- No additional external dependencies beyond the HAP API and its authentication.
Troubleshooting
Common Issues:
- Invalid or missing Worksheet ID or Record ID will result in errors or empty results.
- Pagination parameters (Page Size and Page Index) must be positive integers; invalid values may cause unexpected behavior.
- Using a search term that does not match any discussion content will return an empty list.
- Filtering by "Only With Attachments" when no discussions have attachments will yield no results.
Error Messages:
- Authentication errors indicate issues with the provided API key or credentials; verify and update credentials accordingly.
- "Record not found" or similar errors suggest incorrect Worksheet ID or Record ID.
- Rate limiting or network errors should be handled by retrying after some time or checking network connectivity.