iTwin Issues icon

iTwin Issues

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

Overview

This node interacts with the iTwin Issues API to retrieve issue-related data. Specifically, for the "Get issue details" operation under the "Issues" resource, it fetches detailed information about a single issue identified by its ID. This is useful in scenarios where you want to programmatically access specific issue metadata or status from an iTwin project, such as integrating issue tracking into automated workflows or dashboards.

Practical examples include:

  • Automatically retrieving issue details when a new issue ID is received from another system.
  • Enriching data records with issue information for reporting or notification purposes.
  • Integrating issue details into custom applications or services that consume iTwin platform data.

Properties

Name Meaning
ID The unique identifier of the issue to get details for. This is a required string input specifying which issue's details to retrieve.

Output

The node outputs JSON data representing the detailed information of the requested issue. The structure corresponds to the response from the iTwin Issues API and typically includes fields such as issue ID, title, description, status, creation date, assigned users, and other metadata related to the issue.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Issues API.
  • Depends on the iTwin Issues REST API endpoint at https://api.bentley.com.
  • Uses internal helper utilities for making authenticated HTTP GET requests.
  • Requires network connectivity to the iTwin platform API.

Troubleshooting

  • Common issues:
    • Invalid or missing issue ID will cause the API request to fail.
    • Authentication errors if the API key or OAuth2 credentials are not properly configured.
    • Network or permission issues accessing the iTwin API endpoint.
  • Error messages:
    • "Unsupported operation": Indicates the specified operation is not implemented; ensure "get-issue-details" is selected.
    • API errors returned from the iTwin platform (e.g., 404 Not Found if the issue ID does not exist).
  • Resolutions:
    • Verify the issue ID is correct and exists in the target iTwin project.
    • Confirm that the API credentials are valid and have necessary permissions.
    • Check network connectivity and firewall settings.

Links and References

Discussion