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 programmatically. Specifically, the "Delete Application" operation enables users to remove an application from the Component Center by specifying its unique ID. This is useful in scenarios where applications are deprecated, no longer needed, or require cleanup to maintain an organized component repository.

Practical examples include:

  • Automating the removal of outdated applications during a CI/CD pipeline.
  • Cleaning up test or temporary applications created during development.
  • Managing application lifecycle by deleting unused entries to reduce clutter.

Properties

Name Meaning
ID The unique identifier of the application to delete. This is a required string input that specifies which application will be removed from the Component Center.

Output

The node outputs JSON data representing the result of the delete operation. The output structure can vary:

  • If the deletion returns an object or array, it is passed as-is in the json field.
  • If the deletion returns a simple value (e.g., success confirmation), it is wrapped inside an object under the key result.
  • In case of failure and if the node is configured to continue on error, the output contains an error message and additional node info.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin OAuth2 API to authorize requests.
  • Depends on the internal ComponentCenterOpenApiInterpreter module to interpret and execute API operations.
  • Requires network access to the iTwin Component Center API endpoint.

Troubleshooting

  • Unknown operation error: If the specified operation name does not match any known operation, the node throws an error. Ensure the operation parameter is correctly set to "delete-application".
  • Missing or invalid ID: Since the ID is required, omitting it or providing an incorrect value will cause the API call to fail. Verify the ID corresponds to an existing application.
  • API authentication errors: Failure to provide valid credentials or expired tokens will result in authorization errors. Check the configured API key or OAuth2 token.
  • Continue on Fail behavior: If enabled, errors do not stop execution but return error details in the output JSON, allowing workflows to handle failures gracefully.

Links and References

  • iTwin Developer Documentation
  • Refer to the official iTwin Component Center API docs for detailed information on application management endpoints.

Discussion