iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Overview

This node interacts with the iTwin Platform's iModels API, specifically to manage iModels. The "Delete iModel" operation allows users to delete an existing iModel by specifying its unique identifier. This is useful in scenarios where outdated or unnecessary iModels need to be removed from the platform to maintain organization or reduce clutter.

Practical examples include:

  • Automating cleanup of test or temporary iModels after a project phase.
  • Removing iModels that are no longer relevant due to project completion or changes.
  • Integrating with CI/CD pipelines to manage iModel lifecycle programmatically.

Properties

Name Meaning
ID The unique identifier of the iModel to delete. This is a required string input where you specify the exact iModel id you want to remove.

Output

The output JSON contains the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide details about the operation's outcome. If the operation returns multiple results (unlikely for a delete), each will be output as separate JSON objects.

No binary data output is expected from this operation.

Example output structure:

{
  "result": "<operation result or confirmation>"
}

If an error occurs and the node is set to continue on failure, the output JSON will contain an error field describing the issue.

Dependencies

  • Requires an API authentication token credential configured for the iTwin Platform.
  • Needs network access to the iTwin Platform APIs.
  • The node depends on an internal interpreter module to map operations to API calls.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent iModel ID will cause the operation to fail.
    • Missing or incorrect API credentials will prevent successful authentication.
    • Network connectivity problems can cause timeouts or failures.
  • Error messages:

    • "Unknown operation: delete-imodel" indicates the operation name is not recognized; ensure the correct operation is selected.
    • Errors returned from the API typically include messages about authorization failures or resource not found.
  • Resolutions:

    • Verify the iModel ID is correct and exists in your iTwin account.
    • Confirm that the API key or OAuth token is valid and has sufficient permissions.
    • Check network connectivity and proxy settings if applicable.

Links and References

Discussion