iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API to retrieve variations of brand components. Specifically, the "Get Brand Component Variations" operation fetches all variations associated with a given brand and component IDs. This is useful in scenarios where users need to programmatically access different design or configuration variants of components within a brand, such as for automated cataloging, synchronization, or analysis workflows.

Practical examples include:

  • Automatically fetching all available variations of a specific component in a brand to display in a custom dashboard.
  • Integrating component variation data into a product lifecycle management system.
  • Syncing component variations with other design or engineering tools.

Properties

Name Meaning
Brand ID The unique identifier of the brand whose component variations are fetched.
Component ID The unique identifier of the component within the brand to get variations for.

Output

The output is an array of JSON objects representing the variations of the specified brand component. Each object contains the details of a single variation as returned by the iTwin Component Center API. The exact structure depends on the API response but typically includes identifiers, names, and attributes describing each variation.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 service.
  • Depends on the iTwin Component Center API being accessible.
  • The node uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing Brand ID or Component ID parameters will cause the operation to fail.
    • Authentication errors if the API key or OAuth token is not configured correctly.
    • Network or API availability issues may result in request failures.
  • Error messages:

    • "Unknown operation: <operation>" indicates that the requested operation name is not recognized; ensure the operation parameter is set correctly.
    • Errors related to API calls will be surfaced with their message; enabling "Continue On Fail" allows processing subsequent items even if one fails.
  • Resolution tips:

    • Verify that Brand ID and Component ID inputs are correct and correspond to existing entities.
    • Ensure valid API credentials are configured in n8n.
    • Check network connectivity and API status.

Links and References

Discussion