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 changeset of an iModel. It is useful for users who need to programmatically access metadata or information about specific changesets within an iModel, such as version history, change tracking, or auditing purposes.

A practical example would be a user wanting to fetch detailed information about a certain changeset by its ID or index to display in a dashboard or to trigger further automation based on changes made in that changeset.

Properties

Name Meaning
ID The unique identifier of the iModel from which to get the changeset details.
Changeset The changeset identifier or its index within the iModel to retrieve details for.

Output

The output is a JSON object containing the details of the requested changeset. This typically includes metadata and properties describing the changeset, such as its ID, description, timestamp, and other relevant attributes provided by the iTwin iModels API.

If multiple results are returned (though unlikely for this operation), each will be output as separate JSON objects in the array.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the iTwin Platform iModels API.
  • The node depends on the IModelsOpenApiInterpreter module internally to map operations and execute API calls.
  • Proper configuration of the OAuth2 API credentials for the iTwin platform is necessary.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent iModel ID or changeset ID/index will likely result in errors or empty responses.
    • Missing or misconfigured API authentication credentials will cause authentication failures.
    • Network connectivity issues can prevent successful API calls.
  • Error messages:

    • "Unknown operation: <operation>": Indicates the specified operation name is not recognized; ensure the operation parameter is correctly set to "get-imodel-changeset-details".
    • Errors related to authentication or authorization usually indicate problems with the API key or OAuth2 token setup.
    • If the node throws an error but "Continue On Fail" is enabled, the error message will be included in the output JSON under the error field.

Links and References

Discussion