iTwin Component Center

Overview

This node integrates with the iTwin Component Center API, allowing users to manage components within the iTwin ecosystem. Specifically, the "Delete Component" operation enables users to remove a component by its unique identifier. This is useful in scenarios where outdated or unwanted components need to be programmatically deleted as part of automation workflows.

Practical examples include:

• Automatically cleaning up deprecated components after a release cycle.
• Managing component lifecycle by deleting test or temporary components created during development.
• Integrating component deletion into larger CI/CD pipelines for infrastructure management.

Properties

Output

The output JSON contains the result of the delete operation. Typically, this will be an object indicating success or failure details returned by the API. If the operation returns multiple results (unlikely for delete), each will be output as separate JSON objects.

No binary data output is expected from this operation.

Example output structure might look like:

{
  "result": {
    "status": "success",
    "message": "Component deleted successfully"
  }
}

or, in case of error (if continueOnFail is enabled):

{
  "error": "Error message describing what went wrong",
  "nodeInfo": "iTwin ComponentCenter execution failed"
}

Dependencies

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

Troubleshooting

• Common issues:

  • Invalid or missing component ID will cause the operation to fail.
  • Insufficient permissions or expired API tokens can lead to authorization errors.
  • Network connectivity problems may prevent successful API calls.

• Error messages:

  • "Unknown operation: delete-component" indicates the operation name was not recognized; ensure the correct operation is selected.
  • API errors returned from the iTwin service will be passed through; check the error message for details such as "component not found" or "access denied".
  • If the node is set to continue on fail, errors will appear in the output JSON under the error field.

To resolve errors:

• Verify the component ID is correct and exists.
• Ensure the API credentials are valid and have necessary scopes.
• Check network connectivity and API endpoint availability.

Links and References

• iTwin Developer Documentation
• iTwin Component Center API reference (linked from the documentation above)