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 particular iModel Changeset Group. It is useful in scenarios where users need to fetch metadata or detailed information about changeset groups within an iModel, such as tracking version history, auditing changes, or integrating iModel data into other workflows.

Practical examples include:

  • Fetching changeset group details to display in a dashboard.
  • Automating reports on changes made in specific iModel versions.
  • Integrating changeset group data into project management or BIM coordination tools.

Properties

Name Meaning
ID The unique identifier of the iModel from which to retrieve the changeset group details.
Changeset Group ID The unique identifier of the specific changeset group within the iModel to fetch.

Output

The node outputs JSON data representing the details of the requested iModel Changeset Group. This typically includes metadata and properties describing the changeset group. The exact structure depends on the iTwin Platform API response but generally contains identifiers, timestamps, descriptions, and related changeset information.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin Platform (OAuth2).
  • Depends on the iTwin Platform iModels API being accessible.
  • The node internally uses an interpreter module (IModelsOpenApiInterpreter) to map operations to API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing iModel ID or Changeset Group ID will cause errors.
    • Authentication failures if the API token is invalid or expired.
    • Network connectivity issues to the iTwin Platform API.
  • Error messages:

    • "Unknown operation: <operation>" indicates the specified operation is not recognized; ensure the operation name matches exactly.
    • Errors containing "iTwin IModels execution failed" suggest API call failures; check credentials and input parameters.
  • Resolutions:

    • Verify that the iModel ID and Changeset Group ID are correct and exist.
    • Ensure the OAuth2 credential is properly configured and valid.
    • Check network access and API endpoint availability.

Links and References

Discussion