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 workflows related to iTwin projects. Specifically, the "Get workflow" operation retrieves workflow information for a specified form type within an iTwin or project context. This is useful in scenarios where automated processes or integrations need to fetch workflow configurations or statuses tied to digital twins or infrastructure projects managed via iTwin.
Practical examples include:
- Fetching the current workflow setup for a particular form type in a construction project.
- Automating retrieval of discipline-specific workflows to trigger downstream automation or reporting.
- Integrating iTwin workflow data into broader business process management systems.
Properties
| Name | Meaning |
|---|---|
| Type | The form type for which to get a workflow. |
| iTwin ID | The GUID of the iTwin or project for which to get a workflow. (Alias: projectId) |
| Discipline | Optional. The workflow discipline to filter by. If omitted, all workflows are retrieved regardless of discipline. |
Output
The node outputs JSON objects representing the workflow data retrieved from the iTwin Forms API. Each item corresponds to a workflow matching the input criteria. The exact structure depends on the API response but generally includes details about the workflow configuration, status, and associated metadata.
No binary data output is indicated.
Dependencies
- Requires an API credential for authenticating with the iTwin OAuth2 service.
- Depends on the bundled
FormsOpenApiInterpreterclass to interpret and execute API operations. - Requires network access to the iTwin Forms API endpoint as documented at https://developer.bentley.com/apis/.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating "Unknown operation". Ensure the operation name matches exactly "get-workflow".
- API authentication failures: Missing or invalid OAuth2 credentials will cause authentication errors. Verify that the API key or token is correctly configured in n8n credentials.
- Empty or no results: If the iTwin ID or form type does not correspond to any existing workflows, the output may be empty. Double-check the GUID and form type values.
- Continue on Fail: If enabled, the node will output error messages in the JSON under an
errorfield instead of stopping execution, useful for bulk processing.