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 manage form data and comments programmatically. Specifically, the "Delete comment" operation under the "Comments" resource enables users to delete a specific comment from a given form data instance by providing the relevant IDs.
Common scenarios for this node include:
- Automating the cleanup of outdated or irrelevant comments on form submissions.
- Integrating form comment management into broader workflows, such as removing comments after certain approvals or status changes.
- Maintaining data hygiene by programmatically deleting comments based on external triggers.
For example, a user might set up a workflow that deletes a comment from a form entry when a related task is completed in another system.
Properties
| Name | Meaning |
|---|---|
| ID | The ID of the form data instance from which to delete a comment. |
| Comment ID | The ID of the specific comment to delete from the form data instance. |
Output
The output of this operation is a JSON object representing the result of the delete action. Typically, this will confirm whether the deletion was successful or provide details about the deleted comment. If the operation returns an array, each element is output as a separate JSON item.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential for authenticating with the iTwin Forms API (OAuth2-based).
- The node depends on the
FormsOpenApiInterpreterclass to interpret and execute API operations. - Proper configuration of the OAuth2 credentials within n8n is necessary to authorize requests.
Troubleshooting
Common issues:
- Providing incorrect or non-existent form data instance ID or comment ID will likely cause errors.
- Authentication failures if the OAuth2 token is expired or misconfigured.
- Network or API endpoint issues may cause request failures.
Error messages:
"Unknown operation: delete-comment": This indicates the operation name was not recognized; ensure the operation parameter is correctly set.- Errors containing
"iTwin Forms execution failed"indicate runtime issues during API calls; check credentials and input parameters.
Resolutions:
- Verify that the IDs provided are correct and exist in the iTwin Forms system.
- Refresh or reconfigure the OAuth2 credentials if authentication errors occur.
- Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.
Links and References
- iTwin Developer Documentation
- n8n documentation on OAuth2 Credentials