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 manage issues, including retrieving issue attachments. Specifically, the "Get issue attachments" operation fetches all attachments related to a specified issue by its ID. This is useful in scenarios where users want to programmatically access files or documents linked to an issue for review, processing, or integration with other systems.

Practical examples:

  • Automatically downloading all attachments from a specific issue to archive them.
  • Integrating issue attachments into a document management system.
  • Triggering workflows based on the presence or content of attachments in an issue.

Properties

Name Meaning
ID The unique identifier of the issue for which to retrieve attachments.

Output

The node outputs an array of JSON objects representing the attachments of the specified issue. Each object contains metadata and details about an attachment as returned by the iTwin Issues API. If the attachments include binary data (e.g., files), this would typically be represented in the output's binary property, allowing further processing or download within n8n.

Dependencies

  • Requires an API authentication token credential configured for the iTwin platform (OAuth2).
  • Depends on the iTwin Issues API endpoint at https://api.bentley.com.
  • Uses internal shared utilities for making authenticated API requests.
  • Requires proper configuration of the OAuth2 credentials in n8n to authorize API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing issue ID: The node requires a valid issue ID; providing an empty or incorrect ID will cause errors.
    • Authentication failures: Ensure the OAuth2 credential is correctly set up and has necessary permissions.
    • Network or API endpoint errors: Check connectivity and API availability.
  • Error messages:

    • "Unsupported operation": Indicates that the selected operation is not implemented or recognized by the node.
    • API request errors: May include HTTP status codes and messages from the iTwin API; verify credentials and input parameters.
  • Resolutions:

    • Double-check the issue ID input.
    • Verify OAuth2 credentials and refresh tokens if needed.
    • Review API documentation for any changes or required scopes.

Links and References


Note: The provided bundled source code shows the node structure and partial implementation but does not explicitly show the detailed logic for the "get-issue-attachments" operation. However, based on the properties and naming conventions, the above summary reflects the intended functionality.

Discussion