iTwin Component Center

Overview

This node integrates with the iTwin Component Center API to retrieve web links associated with a specific brand component. The "Get Brand Component WebLinks" operation fetches all relevant weblinks for a given brand and component combination. This is useful in scenarios where users want to programmatically access or display URLs related to components within a brand, such as documentation links, download pages, or other resource references.

Practical examples include:

• Automatically gathering all reference links for a component to generate reports.
• Integrating component-related URLs into dashboards or other systems.
• Fetching up-to-date links for use in automated workflows or notifications.

Properties

Output

The node outputs an array of JSON objects representing the retrieved weblinks for the specified brand component. Each item in the output corresponds to one weblink object returned by the iTwin Component Center API. The exact structure depends on the API response but typically includes URL details and metadata about each link.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the iTwin Component Center API (referred generically as an API authentication token).
• The node uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to map operations and execute API calls.
• Proper configuration of the OAuth2 API credentials is necessary to authorize requests.

Troubleshooting

• Common issues:

  • Invalid or missing Brand ID or Component ID parameters will cause the API call to fail.
  • Authentication errors if the API key or OAuth2 token is not configured correctly.
  • Network or API downtime can result in request failures.

• Error messages:

  • "Unknown operation: get-brand-component-weblinks" indicates the operation name is incorrect or not supported.
  • Errors containing "iTwin ComponentCenter execution failed" suggest issues during API interaction; check credentials and parameter correctness.

• Resolutions:

  • Verify that Brand ID and Component ID are correctly provided and valid.
  • Ensure the API authentication token is properly set up and has required permissions.
  • Use the node's "Continue On Fail" option to handle intermittent API errors gracefully.

Links and References

• iTwin Developer Documentation
• Node documentation URL (as per node description): https://developer.bentley.com/apis/