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
The "iTwin Forms" node integrates with the iTwin Forms API, enabling users to interact with form data programmatically within n8n workflows. Specifically, the "Get form data details" operation retrieves detailed information about a particular instance of form data by its unique ID. This is useful for scenarios where you need to fetch and process submitted form responses, audit form entries, or integrate form data into other systems.
Practical examples include:
- Automatically retrieving form submission details after a user completes a form.
- Using form data to trigger downstream automation such as notifications or data synchronization.
- Auditing or reporting on specific form entries based on their IDs.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the form data instance to retrieve. This is required to specify which form data record should be fetched. |
Output
The node outputs JSON data representing the detailed information of the requested form data instance. The structure depends on the response from the iTwin Forms API but generally includes all fields and metadata associated with that form submission.
If multiple results are returned (though unlikely for a single ID query), each will be output as a separate JSON object in the array.
No binary data output is indicated by the source code.
Dependencies
- Requires an API authentication credential for the iTwin Forms API (an OAuth2-based API key or token).
- The node uses an internal interpreter class (
FormsOpenApiInterpreter) to handle API operations. - Proper configuration of the iTwin OAuth2 credentials in n8n is necessary for successful API calls.
Troubleshooting
- Unknown operation error: If the operation parameter is set incorrectly or not supported, the node throws an error indicating an unknown operation. Ensure the operation name matches exactly "get-form-data-details".
- Missing or invalid ID: Since the ID property is required, omitting it or providing an invalid ID may cause the API call to fail or return errors.
- API authentication failures: Incorrect or expired API credentials will result in authentication errors. Verify that the OAuth2 credentials are correctly configured and valid.
- Continue on Fail behavior: If enabled, the node will catch errors and output them as JSON objects instead of stopping the workflow, allowing partial processing of multiple inputs.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Forms API documentation for detailed schema and usage of form data endpoints.