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 retrieve issue data related to iTwins or projects. It is designed to fetch issues from an iTwin platform, supporting pagination and filtering by issue type and state. This node is useful in scenarios where users want to integrate issue tracking data from iTwin projects into their workflows, such as monitoring open issues, auditing closed issues, or aggregating issue statistics.

Practical examples include:

  • Fetching all open issues for a specific iTwin project to display in a dashboard.
  • Retrieving paginated lists of issues filtered by type (e.g., defects, tasks).
  • Automating reporting by extracting issue data regularly from an iTwin project.

Properties

Name Meaning
Type The type of issue data to get. If omitted, retrieves all types.
Continuation Token Token to continue fetching the next page of results from a previous paged query. Must be passed exactly as received from the API's _links.next property. If specified without $top, the page size remains the same as before.
iTwin ID Required. The GUID of the iTwin or project to get issues for. Can also be provided using the alias projectId.
State Filter to retrieve only issues in a specific workflow state: Open, Closed, or Draft.

Output

The node outputs an array of JSON objects representing the retrieved issues. Each object corresponds to an individual issue fetched from the iTwin Issues API. The exact structure of each issue object depends on the API response but typically includes fields such as issue identifiers, descriptions, states, types, timestamps, and other metadata.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential configured for OAuth2 authentication with the iTwin platform.
  • Depends on the iTwin Issues API endpoint at https://api.bentley.com.
  • Uses internal shared utilities for making authenticated HTTP requests to the iTwin API.
  • Requires network access to the iTwin API service.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID: Ensure the iTwin or project GUID is correctly provided.
    • Pagination errors: When using continuation tokens, ensure the token is copied exactly from the previous response.
    • Authentication failures: Verify that the OAuth2 credentials are valid and have appropriate permissions.
    • Unsupported operations: The node currently supports only specific operations; using unsupported ones will cause errors.

  • Error messages:

    • "Unsupported operation: <operation>": Indicates the requested operation is not implemented. Check the operation parameter.
    • Network or authentication errors: Usually indicate issues with API connectivity or credentials.
    • JSON parsing or unexpected response errors: May occur if the API response format changes or is invalid.

To resolve these, verify input parameters, check credentials, and consult the iTwin API documentation for correct usage.

Links and References

Discussion