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 programmatically with forms data. Specifically, the "Add comment to form" operation enables adding a textual comment to an existing form data instance identified by its ID. This is useful in scenarios where collaborative feedback or annotations need to be appended to form entries within automated workflows.
Practical examples include:
- Automatically appending review comments to submitted forms after validation.
- Adding status updates or notes to forms as part of a multi-step approval process.
- Logging user feedback or system-generated messages directly into form records.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the form data instance to which the comment will be added. |
| Text | The content of the comment to add to the form. |
| Options | Additional optional settings: |
| • Custom Payload | Allows overriding the default request body with a custom JSON payload for advanced use cases. |
Output
The node outputs JSON objects representing the response from the iTwin Forms API after attempting to add the comment. The structure typically contains details about the updated form or confirmation of the comment addition. If multiple results are returned, each is output as a separate JSON object.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Forms API.
- Depends on the
FormsOpenApiInterpreterclass (bundled internally) to map and execute API operations. - Network connectivity to the iTwin Forms API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing form ID: Ensure the provided ID corresponds to an existing form data instance.
- Authentication errors: Verify that the API key or OAuth2 credentials are correctly set up and have sufficient permissions.
- Malformed comment text or custom payload: Validate input formats, especially when using the custom JSON payload option.
Error messages:
"Unknown operation: <operation>": Indicates the specified operation name is not recognized; check spelling and case.- API errors returned from the iTwin Forms service will be passed through; inspect the error message for details.
- If the node fails but "Continue On Fail" is enabled, error details will appear in the output JSON under an
errorproperty.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Forms API docs for detailed information on form data structures and comment capabilities.