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 changeset groups associated with an iModel. Changeset groups represent collections of changesets that track modifications made to an iModel over time. This operation is useful for users who want to audit, analyze, or manage the history and evolution of their digital models in the iTwin ecosystem.

Practical examples include:

  • Fetching all changeset groups for a given iModel to display version history.
  • Integrating changeset group data into project management or BIM workflows.
  • Automating reports on model updates by retrieving changeset metadata.

Properties

Name Meaning
ID The unique identifier of the iModel whose changeset groups you want to retrieve. This is a required string input.

Output

The node outputs JSON data representing the changeset groups of the specified iModel. Each item in the output array corresponds to a changeset group object returned by the iTwin API. The structure typically includes metadata about each changeset group such as its ID, description, and related timestamps.

If the API returns multiple changeset groups, the node outputs them as an array of JSON objects, each describing one changeset group.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Platform (OAuth2-based).
  • Needs network access to the iTwin Platform APIs.
  • The node depends on an internal interpreter module (IModelsOpenApiInterpreter) to map operations and execute API calls.

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 problems can prevent successful API requests.
  • Error messages:

    • "Unknown operation: get-imodel-changeset-groups" indicates a misconfiguration or typo in the operation parameter.
    • API errors from the iTwin service will be propagated; check the error message for details like unauthorized access or resource not found.
  • Resolutions:

    • Verify the iModel ID is correct and exists in your iTwin environment.
    • Ensure the OAuth2 credentials are valid and have necessary permissions.
    • Enable "Continue On Fail" option to handle partial failures gracefully.

Links and References

Discussion