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 a specific component within a project. It is useful for scenarios where users need to fetch detailed variation data about components managed in the iTwin ecosystem, such as different versions or configurations of a design element.

A practical example would be an engineering team wanting to list all available variations of a particular component in their project to analyze differences or select a suitable variant for further processing.

Properties

Name Meaning
Component ID The unique identifier of the component whose variations you want to retrieve.
Project ID (Optional) The identifier of the project containing the component. Used as a query parameter.

Output

The node outputs an array of JSON objects, each representing a variation of the specified component. Each object contains the details returned by the iTwin Component Center API for that variation.

If multiple variations are returned, each will be output as a separate item in the output array under the json property.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 service.
  • Depends on the iTwin Component Center API being accessible and the user having appropriate permissions.
  • No additional environment variables are explicitly required beyond the configured credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Component ID will cause the operation to fail.
    • Incorrect or expired API authentication token may result in authorization errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-component-variations" indicates the operation name was not recognized; ensure the correct operation is selected.
    • Errors related to API calls typically include messages from the iTwin API; verify credentials and network access.
    • If the node fails but "Continue On Fail" is enabled, error details will be included in the output JSON under an error field.

Links and References

Discussion