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 and retrieve issue-related data within the iTwin platform. Specifically, for the "Get issue audit trail" operation under the "Issues" resource, it fetches the audit entries (history or change log) associated with a particular issue by its ID. This is useful for tracking changes, updates, or actions performed on an issue over time.

Practical scenarios include:

  • Auditing who made changes to an issue and when.
  • Displaying a detailed history of issue modifications in project management workflows.
  • Integrating issue change logs into reporting or notification systems.

Properties

Name Meaning
ID The unique identifier of the issue for which the audit trail entries are retrieved. This is a required string input.

Output

The node outputs an array of JSON objects representing the audit trail entries for the specified issue. Each entry typically contains details such as timestamps, user information, and descriptions of changes made to the issue.

If the node supports binary data output (not evident from the provided code), it would represent attachments or related files linked to the audit trail, but 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 API endpoint at https://api.bentley.com.
  • Uses internal helper modules for API request execution and logging.
  • Requires proper configuration of the OAuth2 credentials for authorization.

Troubleshooting

  • Common issues:

    • Invalid or missing issue ID will cause the API call to fail.
    • Network or authentication errors if the API key or OAuth token is misconfigured.
    • Unsupported operations or resources if parameters are incorrectly set.
  • Error messages:

    • "Unsupported operation: get-issue-audit-trail": Indicates that the operation is not implemented or recognized; verify the operation name.
    • API response errors related to authorization or invalid IDs will be surfaced; ensure credentials and inputs are correct.
  • Resolution tips:

    • Double-check the issue ID input for correctness.
    • Ensure the OAuth2 API credentials are valid and have necessary permissions.
    • Enable "Continue On Fail" option to handle errors gracefully during batch processing.

Links and References


Note: The provided bundled source code does not explicitly show the implementation for the "get-issue-audit-trail" operation URL construction or API call, suggesting it might be handled elsewhere or requires extending the existing operations list. The summary assumes standard behavior based on the node's structure and naming conventions.

Discussion