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 interacts with the iTwin Forms API, specifically allowing users to upload a file to update a list group within an iTwin project. It is useful in scenarios where you need to programmatically update or replace the contents of a list group by uploading a new file, such as bulk updating form data or synchronizing external datasets with iTwin list groups.
Practical examples include:
- Automating updates to list groups when new data files are generated externally.
- Integrating iTwin list groups with other systems by regularly uploading updated files.
- Managing large sets of form-related data efficiently through batch uploads.
Properties
| Name | Meaning |
|---|---|
| iTwin ID | The unique identifier of the iTwin project that owns the list group being updated. |
| ID | The unique identifier of the specific list group to update with the uploaded file. |
| Options | Additional optional settings: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload. If enabled, you can specify any JSON structure to send instead of the standard upload format. |
Output
The node outputs JSON data representing the response from the iTwin Forms API after attempting to upload the list group file. This typically includes confirmation of success, details about the updated list group, or error information if the upload failed.
If a custom payload is used, the output corresponds directly to the API's response to that payload.
No binary data output is indicated for this operation.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate with the iTwin Forms API.
- Depends on the iTwin Forms API being accessible and the user having appropriate permissions to update list groups.
- The node uses an internal OpenAPI interpreter module to handle API requests.
Troubleshooting
Common issues:
- Invalid or missing iTwin ID or list group ID will cause the API call to fail.
- Incorrectly formatted custom JSON payloads may result in API errors.
- Network or authentication failures can prevent successful uploads.
Error messages:
"Unknown operation": Indicates the specified operation name is not recognized; ensure "upload-list-group-file" is selected.- API error responses will be passed through in the output JSON under an
errorproperty if "Continue On Fail" is enabled.
Resolutions:
- Verify all required IDs are correct and exist in your iTwin environment.
- Validate JSON syntax carefully when using the custom payload option.
- Ensure your API credentials are valid and have sufficient permissions.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Forms API documentation for detailed information on list group file upload endpoints and payload formats.