iTwin Issues icon

iTwin Issues

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

Actions27

Overview

This node interacts with the iTwin Issues API to manage and retrieve issue-related data within the iTwin platform. Specifically, for the "Get issue comments" operation under the "Issues" resource, it fetches all comments associated with a specified issue ID. This is useful in scenarios where users want to review discussions, feedback, or updates related to a particular issue tracked in an iTwin project.

Practical examples include:

  • Displaying all comments on a construction defect issue to understand its resolution history.
  • Aggregating user feedback comments on a design issue for reporting purposes.
  • Monitoring ongoing conversations on issues directly within an automation workflow.

Properties

Name Meaning
ID The unique identifier of the issue for which comments are to be retrieved. This is a required string input.

Output

The node outputs an array of JSON objects representing the comments associated with the specified issue. Each object typically contains details such as the comment text, author information, timestamps, and possibly metadata about the comment.

If the node supports binary data output (not evident from the provided code), it would represent attachments or media related to comments; however, this is not indicated here.

Dependencies

  • Requires an API authentication token credential configured in n8n to access 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 requests.
  • Requires the "iTwinOAuth2Api" credential to authenticate API calls.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent issue ID will result in no comments returned or an error from the API.
    • Missing or misconfigured API credentials will cause authentication failures.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors thrown by the node will include messages from the underlying API or network layer.
    • If the operation is unsupported or incorrectly specified, the node throws an "Unsupported operation" error.
    • When errors occur, if "Continue On Fail" is enabled, the node returns an error object in the output instead of stopping execution.

  • Resolutions:

    • Verify the issue ID is correct and exists in the iTwin project.
    • Ensure the API key or OAuth2 credentials are properly set up and valid.
    • Check network connectivity and proxy settings if applicable.
    • Use the node's debug logs to trace request URLs and headers for troubleshooting.

Links and References

Discussion