iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node interacts with the iTwin Component Center API to retrieve documents from a specified catalog. Specifically, the "Get Catalog Document" operation fetches a single document by its ID within a given catalog. This is useful in scenarios where you need to programmatically access detailed information or metadata about specific components or documents stored in an iTwin catalog.

Practical examples include:

  • Automating retrieval of component specifications for integration into design workflows.
  • Fetching documentation or metadata for components during a build or deployment pipeline.
  • Querying and displaying component details in custom dashboards or reports.

Properties

Name Meaning
Catalog ID The unique identifier of the catalog from which to retrieve the document.
Document ID The unique identifier of the document to retrieve within the specified catalog.

Output

The output is a JSON object representing the retrieved document's data as returned by the iTwin Component Center API. This typically includes all relevant fields and metadata associated with the document.

If multiple documents were returned (not applicable here since this operation targets a single document), they would be output as an array of JSON objects. No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node depends on the iTwin OAuth2 authentication mechanism configured in n8n.
  • Internet connectivity to reach the iTwin Component Center API endpoint.
  • The bundled code imports an internal interpreter module to handle API operations.

Troubleshooting

  • Common issues:

    • Invalid or missing Catalog ID or Document ID parameters will cause the operation to fail.
    • Authentication errors if the API key or OAuth2 credentials are not properly configured.
    • Network connectivity problems can prevent successful API calls.
    • Unknown operation errors if the operation name is misspelled or unsupported.

  • Error messages:

    • "Unknown operation: get-catalog-document" indicates the operation parameter was not recognized; verify spelling and case.
    • Authentication failures will typically return HTTP 401 or 403 errors; ensure valid credentials are set up.
    • If the document or catalog does not exist, the API may return a 404 error; confirm IDs are correct.

Links and References

Discussion