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 perform various operations related to forms management within the iTwin platform. Specifically, the "Delete form data" operation enables users to delete a particular instance of form data by specifying its unique ID. This is useful in scenarios where form submissions or stored form data need to be programmatically removed, such as cleaning up outdated records or managing data lifecycle.
Practical examples include:
- Automatically deleting form entries after processing them.
- Removing erroneous or duplicate form submissions.
- Managing storage by purging old form data based on business rules.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the form data instance that you want to delete. This must be provided to specify which form data entry should be removed. |
Output
The output of this operation is a JSON object representing the result of the deletion request. Typically, it will contain confirmation details or status information returned by the iTwin Forms API indicating whether the deletion was successful.
If the API returns an array of objects, each item is output as a separate JSON object. Otherwise, the single response object or a wrapped result is output under the json field.
No binary data output is involved in this operation.
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 depends on the
FormsOpenApiInterpreterclass to interpret and execute API operations. - Proper configuration of the OAuth2 credential in n8n is necessary for authentication.
Troubleshooting
Common issues:
- Providing an invalid or non-existent form data ID will likely cause the API to return an error.
- Missing or expired API authentication tokens will prevent successful API calls.
- Network connectivity issues can cause timeouts or failures.
Error messages:
"Unknown operation: <operation>": Indicates the specified operation name is not recognized; ensure the operation parameter is correctly set to "delete-form-data".- API errors returned from the iTwin Forms service will be propagated; these often include HTTP status codes and messages explaining the failure (e.g., 404 Not Found if the ID does not exist).
- If the node is set to continue on fail, errors are captured in the output JSON under an
errorfield with a message describing the issue.
Resolution tips:
- Verify the form data ID is correct and exists.
- Ensure the OAuth2 credential is valid and has not expired.
- Check network connectivity and API endpoint availability.
- Enable "Continue On Fail" option to handle errors gracefully during batch executions.
Links and References
- iTwin Developer Documentation
- Refer to the official iTwin Forms API documentation for detailed information about form data management endpoints and expected responses.