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, specifically to retrieve attachment files by their ID associated with an issue. It is useful in scenarios where you need to programmatically access and download attachments linked to issues tracked within the iTwin platform. For example, if you have an issue tracking system integrated with iTwin and want to automate fetching specific attachments for reporting or processing, this node enables that functionality.

Properties

Name Meaning
ID The unique identifier of the issue from which to get the attachment.
Attachment ID The unique identifier of the attachment file to retrieve.

Output

The node outputs JSON data representing the retrieved attachment file. This typically includes metadata about the attachment and the file content itself. If the attachment is a binary file, the node will provide it in the binary output format suitable for further processing or saving.

Dependencies

  • Requires an API key credential for authenticating with the iTwin OAuth2 service.
  • Needs network access to the Bentley iTwin API endpoint (https://api.bentley.com).
  • Uses internal shared utilities for making authenticated API requests.
  • No additional environment variables are explicitly required beyond the configured API credentials.

Troubleshooting

  • Common issues:
    • Invalid or missing issue ID or attachment ID parameters will cause the request to fail.
    • Authentication errors if the API key credential is not properly configured or expired.
    • Network connectivity problems when reaching the Bentley API endpoint.
  • Error messages:
    • "Unsupported operation": Indicates the operation parameter is incorrect or not implemented.
    • API response errors related to authorization or resource not found will be surfaced as node execution errors.
  • Resolutions:
    • Verify that both the Issue ID and Attachment ID are correctly provided.
    • Ensure the API authentication token is valid and has necessary permissions.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion