iTwin Component Center icon

iTwin Component Center

Comprehensive iTwin Component Center API

Overview

This node integrates with the iTwin Component Center API, allowing users to manage components and their associated web links. Specifically, the "Delete Component WebLink" operation removes a specified web link from a given component in the iTwin Component Center.

Common scenarios for this node include:

  • Automating cleanup of outdated or incorrect web links associated with components.
  • Managing component metadata by programmatically removing unnecessary or deprecated web links.
  • Integrating with CI/CD pipelines to maintain component documentation or references up-to-date.

For example, a user might use this node to delete a broken or obsolete URL linked to a component after a website restructuring.

Properties

Name Meaning
Component ID The unique identifier of the component from which the web link will be deleted.
Web Link ID The unique identifier of the web link to be deleted from the specified component.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide details about the operation's outcome. The output is structured as an array of objects, each containing a json field with the response data.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Component Center API.
  • The node depends on the iTwin Component Center OpenAPI interpreter module internally to map and execute operations.
  • Proper configuration of the OAuth2 API credentials for iTwin is necessary within n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing Component ID or Web Link ID parameters will cause the operation to fail.
    • Authentication errors if the API key or OAuth2 token is not correctly configured.
    • Attempting to delete a non-existent web link may return an error or no-op response.
  • Error messages:

    • "Unknown operation: <operation>": Indicates that the specified operation name is not recognized; ensure the operation parameter is set to "delete-component-weblink".
    • API authentication errors: Verify that the API credentials are valid and have sufficient permissions.
    • Network or connectivity errors: Check internet connection and API endpoint accessibility.

Links and References

Discussion