iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node interacts with the iTwin Component Center API to retrieve detailed information about a specific catalog by its ID. It is useful in scenarios where users need to fetch metadata or details of a catalog stored in the iTwin Component Center, such as for integration into workflows that manage or analyze component catalogs.

Practical examples include:

  • Automating retrieval of catalog details for reporting or auditing.
  • Integrating catalog data into other systems or dashboards.
  • Validating catalog existence and properties before further processing.

Properties

Name Meaning
ID The unique identifier of the catalog to retrieve. This is a required string input specifying which catalog's details to fetch.

Output

The node outputs JSON data representing the catalog details retrieved from the iTwin Component Center API. The structure of this JSON depends on the API response but typically includes catalog metadata such as name, description, components included, versioning info, and other relevant attributes.

If multiple items are returned (though unlikely for a single catalog get operation), each item will be output as a separate JSON object in the array.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node depends on the iTwin OAuth2 authentication mechanism configured within n8n.
  • Internet access to the iTwin Component Center API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing catalog ID will cause the API call to fail.
    • Authentication errors if the API key or OAuth token is not properly configured.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-catalog": Indicates the operation parameter was not recognized; ensure "Get Catalog" is selected.
    • API errors returned from the iTwin service will be passed through; check the error message for details.
    • If continueOnFail is enabled, errors will be output as JSON with an error field describing the issue.

Links and References

Discussion