iTwin Component Center

Overview

This node integrates with the iTwin Component Center API to retrieve documents related to specific brand components. The "Get Brand Component Documents" operation fetches all documents associated with a given brand and component IDs. This is useful in scenarios where users need to programmatically access documentation or resources tied to particular components within a brand, such as for automation of document management, auditing, or integration into other workflows.

Practical examples include:

• Automatically retrieving the latest technical documents for a component during a build or deployment pipeline.
• Aggregating component documentation for reporting or compliance purposes.
• Integrating component documents into a knowledge base or content management system.

Properties

Output

The output is an array of JSON objects, each representing a document related to the specified brand component. Each item contains the document's metadata and details as returned by the iTwin Component Center API. The exact structure depends on the API response but typically includes fields like document name, type, URL, version, and other relevant attributes.

No binary data output is indicated by the source code.

Dependencies

• Requires an API authentication token configured via OAuth2 credentials to access the iTwin Component Center API.
• The node depends on the ComponentCenterOpenApiInterpreter module internally to interpret and execute API operations.
• Proper configuration of the OAuth2 credential in n8n is necessary for successful API calls.

Troubleshooting

• Common issues:

  • Invalid or missing Brand ID or Component ID parameters will cause the operation to fail.
  • Authentication errors if the OAuth2 token is expired or misconfigured.
  • Network or API availability issues may result in request failures.

• Error messages:

  • "Unknown operation: get-brand-component-documents" indicates a mismatch or typo in the operation parameter.
  • Errors containing "iTwin ComponentCenter execution failed" suggest API call failures; check credentials and network connectivity.

• Resolutions:

  • Verify that Brand ID and Component ID are correctly provided and correspond to existing entities.
  • Ensure OAuth2 credentials are valid and refreshed.
  • Enable "Continue On Fail" option to handle errors gracefully within workflows.

Links and References

• iTwin Developer Documentation
• Refer to the official iTwin Component Center API docs for detailed information on document structures and additional operations.