Actions58
- Applications Actions
- Components Actions
- Brands Actions
- Documents Actions
- Weblinks Actions
- Manufacturers Actions
- Catalogs Actions
- Download Actions
- Variations Actions
- Categories Actions
- Upload Actions
- Jobs Actions
Overview
This node integrates with the iTwin Component Center API, allowing users to manage catalogs and other resources within the iTwin ecosystem. Specifically, the "Delete Catalog" operation enables users to remove a catalog by its unique identifier. This is useful in scenarios where outdated or unnecessary catalogs need to be cleaned up to maintain an organized component repository.
Practical examples include:
- Automating cleanup of test or temporary catalogs after deployment pipelines.
- Removing deprecated catalogs as part of maintenance workflows.
- Integrating catalog management into broader DevOps processes for infrastructure as code.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the catalog to delete. This is a required string input that specifies which catalog will be removed. |
Output
The output of this node is a JSON object representing the result of the delete operation. Typically, it contains confirmation details or status information returned from the iTwin Component Center API about the deletion. If the operation returns multiple results, each is output as a separate JSON item.
No binary data output is produced by this operation.
Dependencies
- Requires an API authentication token credential for the iTwin OAuth2 API to authorize requests.
- Depends on the iTwin Component Center API being accessible and the user having appropriate permissions to delete catalogs.
- The node uses an internal interpreter module to map operations to API calls.
Troubleshooting
Common issues:
- Invalid or missing catalog ID will cause the operation to fail.
- Insufficient permissions or expired API tokens can lead to authorization errors.
- Network connectivity problems may prevent communication with the iTwin API.
Error messages:
"Unknown operation: delete-catalog"indicates the operation name was not recognized; ensure the correct operation is selected.- API error messages related to authorization or resource not found should be checked against the provided catalog ID and credentials.
Resolutions:
- Verify the catalog ID is correct and exists.
- Ensure the API key or OAuth token is valid and has necessary scopes.
- Check network access and retry if transient errors occur.
Links and References
- iTwin Developer Documentation
- iTwin Component Center API Reference (for detailed API capabilities)