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 to download thumbnails of iModels. Specifically, the "Download iModel Thumbnail" operation fetches a thumbnail image for a given iModel identified by its ID. This is useful in scenarios where you want to display or process visual previews of iModels within your workflow, such as generating reports, dashboards, or integrating with other systems that require a quick visual reference of an iModel.
Practical examples include:
- Automatically retrieving and displaying iModel thumbnails in a project management dashboard.
- Archiving thumbnail images alongside metadata for documentation purposes.
- Using thumbnails as part of notifications or alerts related to iModel updates.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel whose thumbnail you want to download. This is required. |
| Size | The size of the thumbnail image to retrieve. If not specified, defaults to small. Possible values depend on the API but typically include sizes like small, medium, large. |
Output
The node outputs JSON data representing the downloaded thumbnail. While the exact structure is not fully detailed in the source, it typically includes the binary content of the thumbnail image or a URL/reference to it. Since this operation downloads a thumbnail, the output likely contains either:
- A binary field containing the image data of the thumbnail (e.g., PNG or JPEG).
- Or a JSON object with metadata about the thumbnail and possibly a link or encoded image data.
If binary data is included, it represents the actual thumbnail image corresponding to the requested iModel and size.
Dependencies
- Requires an API key credential for authenticating with the iTwin Platform's API.
- The node depends on the iTwin Platform's iModels API endpoint to fetch thumbnail images.
- Proper OAuth2 credentials must be configured in n8n to authorize requests.
Troubleshooting
Common issues:
- Invalid or missing iModel ID will cause the operation to fail.
- Incorrect or expired API authentication tokens can lead to authorization errors.
- Requesting a thumbnail size not supported by the API may result in defaulting to small or an error.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation": Indicates the operation parameter was not recognized; ensure "get-imodel-thumbnail" is selected.- Authorization errors: Check that the API key or OAuth2 token is valid and has necessary permissions.
"iModel id is required"or similar validation errors: Make sure the ID property is provided and correctly formatted.
Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring network access to the iTwin API.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (for details on thumbnail sizes and endpoints)