iTwin Component Center

Overview

This node integrates with the iTwin Component Center API, allowing users to interact with various resources and operations related to iTwin components. Specifically, the "Get Catalog WebLink" operation retrieves details about a specific web link associated with a catalog in the Component Center. This is useful for scenarios where you need to programmatically access metadata or URLs related to component catalogs, such as fetching documentation links, external references, or related resources.

Practical examples include:

• Automating retrieval of web links for catalogs to display in dashboards.
• Integrating catalog web link data into other workflows or systems.
• Validating or auditing catalog web links within an automated process.

Properties

Output

The output is an array of JSON objects representing the response from the iTwin Component Center API for the requested web link. Each item contains detailed information about the specified web link, such as its URL, description, and any other metadata provided by the API.

If the operation returns multiple items (though typically it should be one for this operation), each will be a separate JSON object in the output array.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the iTwin OAuth2 API.
• The node depends on the ComponentCenterOpenApiInterpreter module internally to map and execute API operations.
• Proper configuration of the iTwin OAuth2 API credentials in n8n is necessary for successful execution.

Troubleshooting

• Common issues:

  • Invalid or missing Catalog ID or Web Link ID parameters will cause the API call to fail.
  • Authentication errors if the OAuth2 API credentials are not set up correctly.
  • Network or API availability issues may result in request failures.

• Error messages:

  • "Unknown operation: <operation>": Indicates that the specified operation name is not recognized by the node. Ensure the operation parameter is set correctly.
  • API errors returned from the iTwin Component Center service will be propagated; check the error message for details.
  • If continueOnFail is enabled, errors will be included in the output JSON under an error field.

Links and References

• iTwin Developer Documentation
• Refer to the iTwin Component Center API docs for detailed schema and usage of catalog weblinks.