iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API to retrieve detailed information about specific component variations within a project. The "Get Component Variation" operation fetches data for a particular variation of a component, identified by their respective IDs. This is useful in scenarios where users need to programmatically access metadata or configuration details of component variations for automation, auditing, or integration purposes.

Practical examples include:

  • Automatically retrieving the latest variation details of a component during a CI/CD pipeline.
  • Fetching variation metadata to display in custom dashboards or reports.
  • Integrating component variation data into other systems for synchronization or validation.

Properties

Name Meaning
Component ID The unique identifier of the component whose variation you want to retrieve.
Variation ID The unique identifier of the specific variation of the component to fetch.
Project ID (Optional) The identifier of the project that contains the component and its variations.

Output

The node outputs JSON data representing the requested component variation's details. The structure typically includes all relevant metadata and attributes associated with that variation as returned by the iTwin Component Center API. If multiple items are returned (though unlikely for this single-get operation), they will be output as an array of JSON objects.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin Component Center API.
  • The node depends on the iTwinOAuth2Api credential configured in n8n for OAuth2 authentication.
  • Internet connectivity to reach the iTwin Component Center API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Component ID or Variation ID parameters will cause errors.
    • Authentication failures if the OAuth2 credentials are not properly set up or expired.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-component-variation" indicates the operation parameter was incorrect or unsupported.
    • Errors related to missing required parameters will prompt users to verify input fields.
    • API errors from the iTwin service will be passed through; checking the API documentation for error codes is recommended.
  • Resolutions:

    • Ensure all required IDs are correctly provided.
    • Verify OAuth2 credentials are valid and have necessary scopes.
    • Check network access and proxy settings if applicable.

Links and References

Discussion