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 retrieve details about a "Create iModel" operation. It is useful for users who want to programmatically access metadata or status information related to the creation process of an iModel within the iTwin ecosystem. Practical applications include automation workflows that monitor iModel creation progress, validate creation parameters, or integrate iModel creation details into broader project management systems.

Properties

Name Meaning
ID The unique identifier of the iModel for which the creation operation details are requested. This is a required string input.

Output

The output is a JSON object containing the details of the requested "Create iModel" operation. The exact structure depends on the iTwin API response but generally includes metadata such as operation status, timestamps, and any relevant identifiers or messages related to the creation process.

If multiple results are returned, each will be output as a separate JSON object in the array. No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin Platform (OAuth2).
  • Depends on the iTwin Platform's iModels API being accessible.
  • The node uses an internal interpreter module to map operations to API calls.
  • Requires n8n environment configured with the appropriate OAuth2 credentials for iTwin.

Troubleshooting

  • Common issues:
    • Invalid or missing iModel ID will cause the API call to fail.
    • Authentication errors if the OAuth2 token is expired or misconfigured.
    • Network connectivity issues to the iTwin API endpoint.
  • Error messages:
    • "Unknown operation: get-create-imodel-operation-details" indicates the operation name is incorrect or not supported.
    • API error responses will be surfaced in the error field of the output JSON if "Continue On Fail" is enabled.
  • Resolutions:
    • Verify the iModel ID is correct and exists.
    • Ensure OAuth2 credentials are valid and refreshed.
    • Check network access and API endpoint availability.

Links and References

Discussion