iTwin Component Center

Overview

This node interacts with the iTwin Component Center API to manage categories among other resources. Specifically, the "Delete Category" operation allows users to remove a category by its unique identifier. This is useful in scenarios where categories are no longer needed or must be cleaned up to maintain an organized component repository.

Practical examples include:

• Automating cleanup of deprecated or unused categories in a component management system.
• Integrating category deletion as part of a larger workflow that manages component lifecycle.

Properties

Output

The output JSON contains the result of the delete operation. Typically, this might be an object confirming the deletion or providing status information. If the operation returns multiple items (unlikely for a delete), each item would be output separately. In case of failure and if the node is set to continue on error, the output will contain an error message describing what went wrong.

No binary data output is expected from this operation.

Dependencies

• Requires an API key credential for authenticating with the iTwin Component Center API.
• The node depends on the iTwinOAuth2Api credential configured in n8n for OAuth2 authentication.
• Internet access to the iTwin Component Center API endpoint is necessary.

Troubleshooting

• Common issues:

  • Providing an invalid or non-existent category ID will likely cause the API to return an error.
  • Missing or incorrect API credentials will prevent successful authentication.
  • Network connectivity problems can cause request failures.

• Error messages:

  • "Unknown operation: delete-category": This indicates the operation parameter was not recognized; ensure the operation name is correct.
  • API errors returned from the iTwin service will be passed through; these often indicate issues like invalid IDs or permission problems.
  • If the node is set to continue on fail, errors will appear in the output JSON under an error field.

To resolve errors:

• Verify the category ID exists and is correctly formatted.
• Check that the API credentials are valid and have sufficient permissions.
• Ensure network connectivity to the API endpoint.

Links and References

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