iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Actions58

Overview

This node integrates with the iTwin Component Center API to retrieve detailed information about component documents within a project. Specifically, the "Get Component Document" operation fetches a document associated with a given component and project. This is useful in scenarios where users need to programmatically access documentation or metadata related to specific components managed in the iTwin ecosystem.

Practical examples include:

  • Automatically retrieving updated component specifications or manuals during a build or deployment pipeline.
  • Integrating component documentation into custom dashboards or reporting tools.
  • Validating that required documents exist for components before proceeding with further automation steps.

Properties

Name Meaning
Component ID The unique identifier of the component whose document you want to retrieve.
Document ID The unique identifier of the document to fetch for the specified component.
Project ID (Optional) The identifier of the project containing the component and document. Used as a query parameter in the API request.

Output

The node outputs JSON data representing the retrieved component document. The structure of this JSON depends on the API response but generally includes all relevant fields describing the document's content, metadata, and associations.

If multiple documents were returned (not typical for this operation), each would be output as a separate JSON object in the array.

No binary data output is indicated by the source code or properties.

Dependencies

  • Requires an API key credential for authenticating with the iTwin OAuth2 service.
  • Depends on the iTwin Component Center API being accessible and the user having appropriate permissions.
  • The node uses an internal interpreter module (ComponentCenterOpenApiInterpreter) to map operations and execute API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing Component ID, Document ID, or Project ID can cause the API call to fail.
    • Authentication errors if the API key credential is not configured correctly.
    • Network or permission issues accessing the iTwin Component Center API.

  • Error messages:

    • "Unknown operation: <operation>" indicates the requested operation name is not recognized by the node.
    • Errors from the API will be surfaced in the error field of the output JSON if "Continue On Fail" is enabled.

  • Resolutions:

    • Verify all required IDs are correct and correspond to existing resources.
    • Ensure the API authentication credentials are valid and have necessary scopes.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion