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 allowing users to remove an iModel from their list of favorites. It is useful in scenarios where users want to manage their favorite iModels by removing those they no longer need quick access to. For example, a user who has previously marked several iModels as favorites can use this operation to clean up or update their favorites list by removing specific iModels.

Properties

Name	Meaning
ID	The unique identifier of the iModel to be removed from the user's favorites. This is a required string input.

Output

The output of this node is a JSON object representing the result of the removal operation. Typically, it will contain confirmation details or status information indicating whether the iModel was successfully removed from the favorites. If the operation returns multiple items, each will be output as separate JSON objects in an array. The node does not output binary data.

Dependencies

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

Troubleshooting

Common issues:
- Providing an invalid or non-existent iModel ID will likely cause the operation to fail.
- Missing or incorrect API authentication credentials will prevent successful communication with the iTwin Platform.
Error messages:
- "Unknown operation: <operation>" indicates that the specified operation name is not recognized; ensure "remove-imodel-from-my-favorites" is correctly set.
- Errors related to authentication failures suggest checking the API key or OAuth2 token validity.
To resolve errors, verify the correctness of the iModel ID, ensure valid credentials are configured, and confirm network connectivity to the iTwin API endpoints.

Links and References

iTwin Platform Developer Documentation
Node documentation URL (as per node metadata): https://developer.bentley.com/apis/