Actions28
- Attachments Actions
- Comments Actions
- Import Actions
- Static Images Actions
- Forms Actions
- Delete form definition
- Update form definition metadata
- Get form definition by ID
- Add comment to form
- Get form data comments
- Download form as file
- Export forms to Storage
- Get form data details
- Update form data
- Delete form data
- Import form definition from another iTwin
- Get iTwin form definitions
- Add attachment to form
- Get form data attachments
- Create form data
- Get iTwin form data
- Get audit trail for form data
- List Groups Actions
- Templates Actions
- Workflows Actions
Overview
This node integrates with the iTwin Forms API, allowing users to interact with form data within the iTwin platform. Specifically, the "Get form data comments" operation retrieves all comments associated with a particular form data instance. This is useful for scenarios where users need to review feedback, annotations, or discussions tied to specific form submissions.
Practical examples include:
- Extracting user comments on a submitted form for review or processing.
- Aggregating feedback from multiple form instances for reporting.
- Automating workflows that depend on comment content or presence.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the form data instance for which to retrieve comments. This is required and must be provided as a string. |
Output
The output is an array of JSON objects representing the comments retrieved from the specified form data instance. Each item in the output corresponds to a single comment's data as returned by the iTwin Forms API. The exact structure depends on the API response but typically includes details such as comment text, author, timestamp, and related metadata.
No binary data output is indicated.
Dependencies
- Requires an active connection to the iTwin Forms API.
- Needs an API authentication token configured via OAuth2 credentials (referred generically as an API key credential).
- The node uses an internal interpreter class to map and execute API operations.
Troubleshooting
Common issues:
- Providing an invalid or non-existent form data ID will likely result in an error or empty results.
- Missing or expired API authentication tokens will cause authentication failures.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation: <operation>"indicates the requested operation name is not recognized by the node; ensure "get-form-data-comments" is correctly specified.- Errors containing
"iTwin Forms execution failed"suggest runtime issues during API interaction; check credentials and input parameters.
Resolutions:
- Verify the form data ID is correct and exists in the iTwin system.
- Ensure valid OAuth2 credentials are set up and refreshed if expired.
- Confirm network access to the iTwin API endpoints.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Forms API docs for detailed schema of form data comments and authentication setup.