iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API, allowing users to interact with components stored in the iTwin ecosystem. Specifically, the "Get Component" operation retrieves detailed information about a single component by its unique identifier. This is useful for scenarios where you need to fetch metadata or details of a specific component within a project, such as displaying component info in dashboards, automating documentation, or integrating component data into other workflows.

Example use cases:

  • Fetching component details to verify version or status before deployment.
  • Retrieving component metadata to enrich project reports.
  • Automating synchronization of component data between iTwin and other systems.

Properties

Name Meaning
ID The unique identifier of the component to retrieve.
Project ID The identifier of the project that the component belongs to. This is sent as a query parameter in the API request.

Output

The output is an array of JSON objects representing the retrieved component(s). For the "Get Component" operation, each item contains the full JSON response from the iTwin Component Center API describing the component's details, such as its properties, metadata, and related information.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for the iTwin platform.
  • The node depends on the iTwin Component Center API being accessible and properly authenticated.
  • No additional external dependencies are required beyond the bundled interpreter module for API operations.

Troubleshooting

  • Common issues:

    • Invalid or missing component ID will cause the API call to fail.
    • Incorrect or expired OAuth2 credentials will result in authentication errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "Unknown operation: get-component" indicates the operation name was not recognized; ensure the correct operation is selected.
    • Errors returned from the API (e.g., 404 Not Found) typically mean the component ID does not exist or is inaccessible.
    • Authentication errors suggest checking the OAuth2 credential configuration and refreshing tokens if necessary.
  • Resolution tips:

    • Verify the component ID and project ID values are correct and exist in the iTwin system.
    • Ensure OAuth2 credentials are valid and have the necessary scopes.
    • Use the node’s "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion