iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Resource Actions
- Get iTwin iModels
- Delete iModel
- Get iModel
- Update iModel
- Create iModel
Userpermissions Actions
- Update iModel User Permissions
- Get iModel User Permissions
Baselinefile Actions
- Complete iModel Baseline File Upload
- Get iModel Baseline File Details
Locks Actions
- Get iModel Locks
- Update iModel Locks
Briefcases Actions
- Get iModel Briefcase
- Release iModel Briefcase
- Acquire iModel Briefcase
- Get iModel Briefcases
Checkpoint Actions
- Get Named Version Checkpoint
- Update Named Version Checkpoint
- Get Briefcase Checkpoint
- Get Changeset Checkpoint
Thumbnail Actions
- Upload iModel Thumbnail
- Download iModel Thumbnail
Extendeddata Actions
- Create Changeset Extended Data
- Get Changeset Extended Data
- Get Changesets Extended Data
Changesets Actions
- Create iModel Changeset
- Get iModel Changesets
- Get iModel Changeset
- Update iModel Changeset
Changesetgroups Actions
- Update iModel Changeset Group
- Get iModel Changeset Group
- Create iModel Changeset Group
- Get iModel Changeset Groups
Permissions Actions
- Get iModel Permissions
Recents Actions
- Get My Recently Used iTwin iModels
- Add iModel to My Recents
Namedversions Actions
- Get iModel Named Versions
- Create iModel Named Version
- Get iModel Named Version
- Update iModel Named Version
Shares Actions
- Get iModel Shares
- Create iModel Share
- Update iModel Share
- Revoke iModel Share
- Get iModel Share
Rolepermissions Actions
- Update iModel Role Permissions
- Get iModel Role Permissions
Users Actions
- Get iModel Users
- Get iModel User
Favorites Actions
- Add iModel to My Favorites
- Remove iModel from My Favorites
- Get My Favorite iTwin iModels
Fork Actions
- Fork iModel
Clone Actions
- Clone iModel
Create Actions
- Get Create iModel Operation Details

Overview

This node interacts with the iTwin Platform's iModels API, specifically to retrieve details about a Named Version of an iModel. It is useful when you want to programmatically access metadata or information about a specific named version within an iModel, such as for auditing, reporting, or integration purposes.

A practical example would be automating the retrieval of version details in a construction project management workflow, where each named version corresponds to a milestone or checkpoint in the design process.

Properties

Name	Meaning
ID	The unique identifier of the iModel from which to get the named version details.
Named Version ID	The unique identifier of the Named Version whose details are to be retrieved.

Output

The output is a JSON object containing the details of the requested Named Version of the specified iModel. This typically includes metadata fields returned by the iTwin Platform API about that Named Version. If multiple results are returned (unlikely in this case), they will be output as an array of JSON objects.

No binary data output is involved.

Dependencies

Requires an API authentication token credential for the iTwin Platform (OAuth2).
The node depends on the bundled IModelsOpenApiInterpreter module to interpret and execute API operations.
Proper configuration of the OAuth2 credential in n8n is necessary to authenticate requests.

Troubleshooting

Common issues:
- Invalid or missing iModel ID or Named Version ID parameters will cause errors.
- Authentication failures if the OAuth2 credential is not configured correctly.
- Unknown operation errors if the operation parameter is misspelled or unsupported.
Error messages:
- "Unknown operation: <operation>": Indicates the specified operation is not recognized; verify the operation name.
- Errors related to authentication usually indicate misconfigured or expired credentials.
- Network or API errors may occur if the iTwin Platform service is unreachable.

To resolve these, ensure all required parameters are provided, credentials are valid and up to date, and network connectivity to the iTwin API is available.