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 to retrieve form definitions associated with a specific iTwin or project. It is useful for users who want to programmatically access metadata about forms used within an iTwin environment, such as retrieving all available forms, filtering by type, status, discipline, or searching by name.
Practical examples include:
- Fetching all approved form templates for a given iTwin project to display in a custom dashboard.
- Searching for form definitions containing a specific keyword to automate form management workflows.
- Filtering forms by their lifecycle status (e.g., Draft, Approved) to integrate with quality control processes.
Properties
| Name | Meaning |
|---|---|
| iTwin ID | The GUID of the iTwin or project to get form definitions for. This is a required identifier and can also be provided using the alias projectId. |
| Type | The form type to filter form definitions by. If omitted, all form types in the iTwin are returned. |
| Search | A case-insensitive string to filter form definitions by name. Only forms whose names contain this string will be included in the results. |
| Status | Filters form definitions by their status. Options are: Draft, Approved, Maintenance, Archived, or Any (to include all statuses). Default is Approved. |
| Discipline | The form discipline to filter form definitions by. If omitted, forms from all disciplines are returned. |
Output
The node outputs an array of JSON objects representing form definitions retrieved from the iTwin Forms API. Each object corresponds to a single form definition and contains its metadata fields as returned by the API.
If multiple form definitions are returned, each is output as a separate item in the output array.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Forms API.
- Depends on the iTwin Forms OpenAPI interpreter module bundled with the node to handle API operations.
- Network connectivity to the iTwin platform's API endpoints is necessary.
Troubleshooting
Common issues:
- Invalid or missing iTwin ID: Ensure the GUID provided is correct and accessible with your credentials.
- Permission errors: Verify that the API key or OAuth token has sufficient permissions to read form definitions.
- No results returned: Check filters like
type,status,discipline, andsearchto ensure they match existing form definitions.
Error messages:
"Unknown operation: <operation>": Indicates the specified operation is not supported by the node. Confirm you are using the exact operation nameget-project-form-definitions.- API request failures may return error messages related to authentication or invalid parameters. Review credentials and input property values.
Links and References
- iTwin Developer Documentation
- iTwin Forms API Reference (general link; specific endpoint docs should be found here)