Actions37
- Groups Actions
- Members Actions
- Roles Actions
- Permissions Actions
- Jobs Actions
- Shares Actions
- Actions Actions
- Users Actions
Overview
This node interacts with the iTwin platform to retrieve information about iTwin Shares. Specifically, the "Get iTwin Shares" operation fetches details of a particular iTwin Share identified by its unique ID. This is useful in scenarios where you need to programmatically access sharing information for collaboration, auditing, or integration purposes within the iTwin ecosystem.
Practical examples include:
- Retrieving share details to display in a dashboard.
- Automating access control checks based on share metadata.
- Integrating iTwin share data into other systems for reporting or synchronization.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iTwin Share to retrieve. This is a required string input that specifies which share's details to fetch. |
Output
The node outputs JSON data representing the details of the requested iTwin Share. The structure typically includes all relevant metadata and properties associated with that share as returned by the iTwin API. The output is an object under the json field of each item.
No binary data output is indicated in the source code.
Dependencies
- Requires an API authentication token credential for the iTwin platform (OAuth2-based).
- Depends on the iTwin Users & Access Control API.
- The node internally uses an interpreter module (
UsersOpenApiInterpreter) to map operations and execute API calls.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Share ID will likely result in an error from the iTwin API.
- Missing or incorrect API credentials will cause authentication failures.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation: get-itwin-shares": Indicates the operation name was not recognized; ensure the operation parameter is correctly set.- Errors related to failed API calls will be caught and can be output as error messages if "Continue On Fail" is enabled.
Resolutions:
- Verify the Share ID is correct and exists.
- Confirm that valid API credentials are configured in n8n.
- Check network connectivity and API endpoint availability.
Links and References
- iTwin Developer Documentation
- Refer to the iTwin Users & Access Control API documentation for detailed schema and usage.