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 to export specified forms as files into a storage system. It is particularly useful when you need to programmatically back up, archive, or share form data in a portable file format such as PDF. For example, a user can export multiple form instances from a project and save them directly into a designated folder in their storage, facilitating automated workflows for documentation or compliance purposes.
Properties
| Name | Meaning |
|---|---|
| Ids | Instance IDs of forms to export. Must include at least 1 and no more than 5 IDs, separated by commas. All IDs must belong to the same project. |
| Include Header | Boolean flag indicating whether to include metadata headers on top of each page in the exported PDF. Defaults to true if not specified. |
| File Type | The type of file to create for the export. Currently, only "PDF" is supported and is the default if not set. |
| Folder ID | The ID of the folder (retrieved from the Storage API) where the exported file should be saved. If omitted, the file will be saved in the project's root folder. |
Output
The node outputs an array of JSON objects representing the result of the export operation. Each output item corresponds to one execution input and contains either:
- The details of the exported file(s), typically including metadata about the saved file(s).
- An error object if the export failed for that input.
No binary data output is indicated by the source code; all results are returned as JSON.
Dependencies
- Requires an API authentication token credential to access the iTwin Forms API.
- Depends on the external iTwin Forms API service for exporting forms.
- Requires configuration of storage folder IDs via the Storage API to specify export destinations.
- The node uses an internal interpreter class (
FormsOpenApiInterpreter) to handle API operations.
Troubleshooting
Common issues:
- Providing more than 5 form IDs or IDs from different projects will likely cause errors.
- Specifying an invalid or inaccessible folder ID may cause the export to fail or default to the root folder.
- Omitting required credentials or having expired tokens will prevent successful API calls.
Error messages:
"Unknown operation: <operation>"indicates an unsupported or misspelled operation name.- Errors related to API failures will be caught and returned in the output JSON under an
errorfield if "Continue On Fail" is enabled.
Resolutions:
- Ensure form IDs are valid, limited to 5, and belong to the same project.
- Verify folder IDs exist and are accessible.
- Confirm that API credentials are correctly configured and valid.
- Use the "Continue On Fail" option to handle partial failures gracefully.
Links and References
- iTwin Developer Documentation
- Refer to the Storage API documentation for managing folder IDs and storage locations.