iTwin iModels
Actions54
- Resource Actions
- Userpermissions Actions
- Baselinefile Actions
- Locks Actions
- Briefcases Actions
- Checkpoint Actions
- Thumbnail Actions
- Extendeddata Actions
- Changesets Actions
- Changesetgroups Actions
- Permissions Actions
- Recents Actions
- Namedversions Actions
- Shares Actions
- Rolepermissions Actions
- Users Actions
- Favorites Actions
- Fork Actions
- Clone Actions
- Create Actions
Overview
This node interacts with the iTwin Platform's iModels API, specifically to retrieve sharing information for a given iModel. It is useful when you need to programmatically access details about who an iModel is shared with, such as collaborators or teams that have access permissions.
A practical example would be automating audits of iModel shares in a project, or integrating iModel share data into other systems for reporting or access management.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel whose share information you want to retrieve. This is a required string input. |
Output
The node outputs JSON data representing the share details of the specified iModel. The structure typically includes information about users or groups the iModel is shared with, their permissions, and related metadata.
If multiple shares exist, the output will be an array of share objects, each describing one share entry.
No binary data output is produced by this operation.
Dependencies
- Requires an API authentication token credential for the iTwin Platform.
- The node depends on the iTwin Platform's iModels API being accessible.
- No additional environment variables are explicitly required beyond standard n8n credential setup.
Troubleshooting
Common issues:
- Providing an invalid or empty iModel ID will cause the operation to fail.
- Network connectivity problems or expired API tokens can lead to authentication errors.
- If the iModel does not exist or the user lacks permission, the API may return an error.
Error messages:
"Unknown operation: get-imodel-shares": Indicates the operation name was not recognized; ensure the operation parameter is correctly set.- Errors related to authentication usually indicate missing or invalid API credentials.
- API errors indicating "not found" or "forbidden" suggest the iModel ID is incorrect or insufficient permissions.
To resolve these, verify the iModel ID, check API credentials, and ensure the authenticated user has appropriate access rights.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference for iModel operations)