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, specifically focusing on managing and retrieving issue-related data within Bentley's iTwin platform. For the "List Groups" resource and the "Get list group" operation, it fetches detailed information about a specific list group used in a form definition by its ID.

Common scenarios for this node include:

  • Retrieving metadata about list groups associated with forms in an iTwin project.
  • Integrating issue management workflows by fetching list group details to display or process them further.
  • Automating reporting or synchronization tasks that require up-to-date list group information.

Practical example:

  • A user wants to get details of a particular list group within a form to display its options dynamically in a custom dashboard or to validate issue data against the list group’s configuration.

Properties

Name Meaning
ID The ID of the form definition this list group is used in.
List Group ID The ID of the list group to retrieve detailed information about.

Output

The node outputs an array of JSON objects representing the retrieved list group(s). Each object contains the detailed properties of the requested list group as returned by the iTwin Issues API.

If the node supports binary data output (not evident from the provided code), it would typically represent attachments or related files, but this is not indicated here.

Dependencies

  • Requires an API key credential for authentication with the iTwin OAuth2 service.
  • Depends on the iTwin Issues API endpoint at https://api.bentley.com.
  • Uses internal helper utilities for making authenticated HTTP requests.
  • Requires proper configuration of the OAuth2 credentials in n8n to authorize API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing form definition ID or list group ID will cause the API request to fail.
    • Authentication errors if the OAuth2 token is expired or misconfigured.
    • Network connectivity problems preventing access to the Bentley API endpoint.

  • Error messages:

    • Errors thrown by the node will include messages from the API or internal exceptions.
    • If the node is set to continue on failure, error details are included in the output JSON under an error field.

  • Resolutions:

    • Verify that the IDs provided are correct and exist in the iTwin project.
    • Ensure the OAuth2 credentials are valid and refreshed.
    • Check network settings and firewall rules to allow outbound HTTPS requests to the Bentley API.

Links and References

Discussion