iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node interacts with the iTwin Projects API to retrieve information about repositories associated with a specific iTwin. The "Get repositories" operation fetches repositories filtered by an iTwin ID, and optionally by class and subclass. This is useful for users who want to programmatically access project repository data within the iTwin platform, such as listing all repositories for a given iTwin or narrowing down results based on classification.

Practical examples:

  • Fetching all repositories linked to a particular iTwin ID to display in a dashboard.
  • Querying repositories of a specific class and subclass to analyze or process only relevant subsets of data.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin whose repositories you want to retrieve. (Required)
Class Optional filter specifying the class of repositories to query. If omitted, all repositories are returned.
Sub Class Optional filter specifying the subclass of repositories to query. Requires Class to be set.

Output

The node outputs an array of JSON objects representing repositories matching the query parameters. Each item corresponds to a repository's data as returned by the iTwin Projects API. The exact structure depends on the API response but typically includes repository metadata such as IDs, names, classes, and other attributes.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 API to authorize requests.
  • Depends on the iTwin Projects API endpoint to fetch repository data.
  • No additional environment variables or external services are explicitly required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Missing or invalid iTwin ID will cause the API call to fail or return no results.
    • Specifying a subclass without a class may result in an error or ignored parameter.
    • Network or authentication errors if the API key/credential is not properly configured.
  • Error messages:

    • "Unknown operation: get-repositories-by-itwin-id": Indicates the operation name is incorrect or unsupported; verify the operation parameter.
    • API errors related to authorization or invalid parameters will be surfaced as node execution errors. Ensure the API credential is valid and parameters are correctly set.

Links and References

Discussion