iTwin Issues icon

iTwin Issues

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

Actions27

Overview

This node operation fetches iTwin form definitions associated with a specific iTwin or project. It allows users to retrieve metadata about forms used for issue tracking and management within the iTwin platform. This is useful in scenarios where you want to dynamically obtain available form templates, filter them by type or status, or search for specific forms by name.

Practical examples include:

  • Automatically listing all approved form definitions for a given project to present options in a user interface.
  • Filtering form definitions by issue type to tailor workflows.
  • Searching form definitions by partial names to quickly find relevant forms.

Properties

Name Meaning
iTwin ID The GUID of the iTwin or project to get form definitions for. (Also accepts "projectId" as an alias.) This identifies the scope from which to retrieve form definitions.
Type The issue type to filter form definitions by. If omitted, all form definitions regardless of type are returned.
Search A case-insensitive string to filter form definitions by their names. Only form definitions containing this string in their names will be included.
Status Filters form definitions by their lifecycle status. Options are: "Draft", "Approved", "Maintenance", "Archived", or "Any" (to include all statuses). Default is "Approved".

Output

The node outputs an array of JSON objects representing the form definitions retrieved from the iTwin API. Each object contains metadata about a form definition such as its identifier, name, type, status, and other relevant properties as provided by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Issues 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 API.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID: Ensure the GUID provided is correct and corresponds to an existing iTwin or project.
    • Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
    • Network or API availability problems: Check connectivity and Bentley's API status.

  • Error messages:

    • "Unsupported operation": Indicates the selected operation is not implemented; verify that "Get iTwin form definitions" is chosen.
    • API request failures with HTTP error codes: Inspect the error message for details; often caused by invalid parameters or expired credentials.
    • "iTwin Issues execution failed": Generic failure message when continue-on-fail is enabled; check preceding logs for root cause.

Links and References

Discussion