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 interact with form templates and related resources within the iTwin ecosystem. Specifically, the "Get templates" operation fetches form templates filtered by optional criteria such as template type and discipline. This is useful for workflows that need to dynamically retrieve and process form definitions based on specific categories or disciplines.
Practical examples include:
- Automatically retrieving all architectural templates to generate project-specific forms.
- Filtering templates by discipline (e.g., structural, electrical) to customize form imports in a construction management workflow.
Properties
| Name | Meaning |
|---|---|
| Type | Filters templates by their type. A template's type determines the form definition type it will have once imported. |
| Discipline | Filters templates by their discipline. A template's discipline determines the form definition discipline it will have once imported. |
Both properties are optional string inputs used as query parameters to narrow down the list of returned templates.
Output
The output is an array of JSON objects representing the retrieved templates. Each item corresponds to a single template with its associated data fields as returned by the iTwin Forms API.
If multiple templates are returned, each is output as a separate JSON object in the array. If a single object or scalar result is returned, it is wrapped accordingly.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 service.
- Depends on the
FormsOpenApiInterpreterclass internally to map and execute API operations. - The node expects the iTwin Forms API to be accessible via network.
Troubleshooting
- Unknown operation error: If the specified operation name does not match any known operation, the node throws an error indicating "Unknown operation". Ensure the operation parameter is correctly set to "get-templates".
- API authentication failures: Missing or invalid OAuth2 credentials will cause authentication errors. Verify that the required API key or OAuth2 token is configured properly.
- Empty results: If no templates match the provided filters, the output will be empty. Try adjusting or removing filter parameters.
- Continue on fail: If enabled, the node will catch errors during execution and output an error object instead of stopping the workflow.
Links and References
- iTwin Developer Documentation
- Node documentation URL (as per node metadata): https://developer.bentley.com/apis/