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 a changeset checkpoint for a given iModel. The "Get Changeset Checkpoint" operation fetches detailed information about a checkpoint associated with a particular changeset within an iModel. This is useful in scenarios where users need to track or audit changes made to digital twins or infrastructure models managed on the iTwin platform.

Practical examples include:

  • Retrieving the state of an iModel at a specific changeset to analyze modifications.
  • Automating workflows that depend on version control or checkpoints within iModels.
  • Integrating iModel changeset data into broader asset management or BIM (Building Information Modeling) processes.

Properties

Name Meaning
ID The unique identifier of the iModel.
Changeset The changeset id or index to get the checkpoint for.

Output

The output is a JSON object representing the changeset checkpoint details retrieved from the iTwin iModels API. It contains structured data about the checkpoint corresponding to the specified changeset and iModel. The exact structure depends on the API response but typically includes metadata about the checkpoint such as its id, timestamp, and related changeset information.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API authentication token credential for the iTwin Platform (OAuth2).
  • Depends on the iTwin iModels OpenAPI interpreter module internally to execute operations.
  • Needs network access to the iTwin Platform API endpoints.

Troubleshooting

  • Common issues:
    • Invalid or missing iModel ID or changeset parameters will cause errors.
    • Authentication failures if the API key or OAuth token is not configured correctly.
    • Network connectivity problems when reaching the iTwin API.
  • Error messages:
    • "Unknown operation: <operation>" indicates an unsupported operation was requested.
    • Errors returned from the API are wrapped and may appear as { error: "<message>", nodeInfo: "iTwin IModels execution failed" } if "Continue On Fail" is enabled.
  • Resolutions:
    • Verify that the iModel ID and changeset values are correct and exist in the iTwin platform.
    • Ensure valid API credentials are set up in n8n.
    • Check network connectivity and API endpoint availability.

Links and References

Discussion