iTwin Issues

iTwin Issues API for issue management, form definitions, attachments, and comments

Actions27

Comments Actions
- Delete comment
List Groups Actions
Static Images Actions
- Get static image
Issues Actions
Workflows Actions
- Get workflow
Attachments Actions
Form Definitions Actions
Import Actions
- Import template
- Import form definition from another iTwin

Overview

This node interacts with the iTwin Issues API to retrieve workflows related to issue management within an iTwin or project. Specifically, for the "Workflows" resource and "Get workflow" operation, it fetches the workflow associated with a given issue type in a specified iTwin or project.

Common scenarios where this node is beneficial include:

Automating retrieval of workflow definitions for specific issue types in digital twin projects.
Integrating workflow data into broader automation pipelines for issue tracking and resolution.
Synchronizing workflow configurations between iTwin platform and other systems.

For example, a user might use this node to get the workflow steps for a "Safety Issue" type in a construction project iTwin, then trigger notifications or update external systems based on the workflow state.

Properties

Name	Meaning
Type	The issue type to get the workflow for. This specifies which kind of issue's workflow should be retrieved.
iTwin ID	The ID of the iTwin or project to get the workflow for. (Alias: projectId) Identifies the target iTwin/project context.

Output

The node outputs an array of JSON objects representing the workflows retrieved from the iTwin Issues API. Each item corresponds to a workflow definition associated with the specified issue type and iTwin/project.

The json output field contains the detailed workflow data as returned by the API, including workflow steps, states, and metadata.

No binary data output is indicated by the source code.

Dependencies

Requires an API key credential for authenticating with the iTwin OAuth2 API.
Depends on the iTwin Issues API endpoint at https://api.bentley.com.
Uses internal shared utilities for making authenticated HTTP requests to the iTwin platform.
Requires proper configuration of the OAuth2 credentials in n8n to access the iTwin APIs.

Troubleshooting

Common issues:
- Invalid or missing iTwin ID or issue type parameters will cause the API request to fail.
- Authentication errors if the OAuth2 token is expired or misconfigured.
- Network connectivity problems reaching the Bentley API endpoint.
Error messages:
- "Unsupported operation": Indicates that the requested operation is not implemented; ensure "get-workflow" is selected.
- API errors returned from the Bentley service will be surfaced; check the error message for details.
- If the node fails but "Continue On Fail" is enabled, error details are included in the output JSON under an error property.
Resolutions:
- Verify all required input properties are correctly set.
- Confirm OAuth2 credentials are valid and have necessary permissions.
- Check network access to https://api.bentley.com.
- Enable debug logging to see detailed request/response information.