iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Actions26

Overview

This node interacts with the iTwin Projects API to retrieve detailed information about a specific repository within an iTwin project. It is designed to fetch data for a given iTwin ID and Repository ID, making it useful in scenarios where users need to programmatically access repository metadata or details as part of automation workflows involving iTwin projects.

Practical examples include:

  • Automating the retrieval of repository details for auditing or reporting.
  • Integrating repository information into other systems or dashboards.
  • Triggering downstream processes based on repository metadata.

Properties

Name Meaning
iTwin ID The unique identifier of the iTwin project to which the repository belongs.
Repository ID The unique identifier of the repository whose details are to be retrieved.

Output

The node outputs JSON data representing the repository details fetched from the iTwin Projects API. The structure typically includes all relevant metadata fields of the repository, such as its name, description, creation date, status, and other attributes defined by the API.

If multiple items were returned (not typical for this operation), they would be output as an array of JSON objects; however, this operation returns a single repository object per execution.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Projects API.
  • Relies on the internal ProjectsOpenApiInterpreter module to map operations and execute API calls.
  • The node expects network connectivity to the iTwin Projects API endpoint.

Troubleshooting

  • Common issues:

    • Invalid or missing iTwin ID or Repository ID parameters will cause the API call to fail.
    • Authentication errors if the API key or OAuth2 token is not properly configured.
    • Network connectivity problems can prevent successful API communication.

  • Error messages:

    • "Unknown operation: get-repository": Indicates the operation parameter was not recognized; ensure the operation is correctly set to "get-repository".
    • API errors returned from the iTwin Projects API will be surfaced, often including HTTP status codes and error messages describing the issue (e.g., "Not Found" if the repository does not exist).

  • Resolution tips:

    • Verify that both iTwin ID and Repository ID are correct and correspond to existing resources.
    • Confirm that the API credentials are valid and have sufficient permissions.
    • Check network settings and firewall rules to allow outbound requests to the iTwin API.

Links and References

Discussion