iTwin Issues icon

iTwin Issues

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

Actions27

Overview

This node integrates with the iTwin Issues API to manage issue comments, specifically allowing deletion of a comment associated with an issue. It is useful in workflows where automated cleanup or management of issue comments is required, such as removing outdated or irrelevant comments from project issues.

For example, you might use this node to delete a specific comment by its ID when a related task is completed or if a comment was posted in error.

Properties

Name Meaning
ID The ID of the issue the comment is associated with.
Comment ID The ID of the comment to delete.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be confirmation that the comment was deleted or an error message if the deletion failed. There is no binary output.

The exact structure depends on the API response but generally includes status information about the deletion request.

Dependencies

  • Requires an API key credential for authentication with the iTwin Issues API.
  • Needs network access to https://api.bentley.com.
  • Uses the iTwinOAuth2Api credential type (an OAuth2 token) for authorization.
  • Relies on internal shared utilities for making authenticated HTTP requests.

Troubleshooting

  • Common issues:

    • Invalid or missing issue ID or comment ID parameters will cause the API call to fail.
    • Authentication errors if the API key or OAuth token is invalid or expired.
    • Network connectivity problems preventing access to the Bentley API endpoint.

  • Error messages:

    • "Unsupported operation": Indicates the operation parameter is incorrect or not implemented.
    • API errors returned from the Bentley service, such as "Comment not found" or "Unauthorized".

  • Resolutions:

    • Verify that both the issue ID and comment ID are correctly provided and correspond to existing resources.
    • Ensure the API credentials are valid and have not expired.
    • Check network connectivity and firewall settings.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion