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 details about a shared iModel instance. The "Get iModel Share" operation fetches information about a particular share of an iModel by using its unique identifiers.
Common scenarios for this node include:
- Retrieving metadata or status of a shared iModel for auditing or display purposes.
- Integrating iModel sharing information into workflows that manage collaboration or access control.
- Automating reporting on shared iModels within an organization.
For example, a user might input an iModel ID and a Share ID to get detailed information about who has access to that shared iModel and what permissions are granted.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel you want to query. |
| Share ID | The unique identifier of the specific share associated with the iModel. |
Output
The node outputs JSON data representing the details of the requested iModel share. This typically includes metadata about the share such as permissions, share status, and possibly user or group information related to the share.
If multiple results were returned (not typical for this operation), each would be output as a separate JSON object in the array.
No binary data output is indicated for this operation.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Platform API.
- Depends on the iTwin Platform's iModels API being accessible and the provided IDs being valid.
- The node uses an internal interpreter module to map operations to API calls.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or Share ID will cause errors.
- Authentication failures if the API key or OAuth token is not properly configured.
- Network or API availability issues may cause timeouts or connection errors.
Error messages:
"Unknown operation: get-imodel-share"indicates the operation name was not recognized; ensure the correct operation is selected.- Errors containing
"iTwin IModels execution failed"suggest problems during API interaction; check credentials and parameter correctness.
Resolutions:
- Verify that both the iModel ID and Share ID are correctly entered and exist in the iTwin platform.
- Ensure the API authentication credential is valid and has necessary permissions.
- Check network connectivity and API service status.