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 to manage documents within catalogs. Specifically, the "Delete Catalog Document" operation allows users to remove a document from a specified catalog by providing the catalog's ID and the document's ID. This is useful in scenarios where outdated or incorrect documents need to be cleaned up or removed from a component catalog.
Practical examples include:
- Automating cleanup of deprecated documents in a catalog.
- Managing document lifecycle by programmatically deleting documents no longer needed.
- Integrating with workflows that maintain catalog contents dynamically based on external triggers.
Properties
| Name | Meaning |
|---|---|
| Catalog ID | The unique identifier of the catalog from which the document will be deleted. |
| Document ID | The unique identifier of the document to delete from the specified catalog. |
Output
The output of this operation is a JSON object representing the result of the delete action. It may contain confirmation details or status information returned by the iTwin Component Center API about the deletion. If multiple items are returned (unlikely for a delete), they are output as an array of JSON objects.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the iTwin Component Center API.
- The node depends on the
iTwinOAuth2Apicredential configured in n8n for OAuth2 authentication. - Network access to the iTwin Component Center API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing Catalog ID or Document ID parameters will cause the operation to fail.
- Authentication errors if the API key or OAuth token is invalid or expired.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation: <operation>": Indicates the requested operation is not supported; ensure "delete-catalog-document" is selected.- API errors related to authorization or resource not found will be passed through; verify IDs and credentials.
Resolutions:
- Double-check that both Catalog ID and Document ID are correctly provided and exist.
- Ensure the API credentials are valid and have sufficient permissions.
- Use the "Continue On Fail" option to handle errors gracefully in workflows.