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 upload a thumbnail image for an iModel. It is useful when you want to programmatically update or set a visual thumbnail representation of an iModel within the iTwin ecosystem. Typical use cases include automating the management of iModel metadata or integrating iModel thumbnail updates into larger workflows that handle iModel lifecycle events.
For example, after generating or modifying an iModel, you might use this node to upload a new thumbnail image that visually represents the current state or version of the iModel.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which the thumbnail will be uploaded. |
| Options | Additional options for the request: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload. You can enable this and provide any JSON structure to send as the request body instead of the standard one. |
Output
The node outputs JSON data representing the response from the iTwin iModels API after attempting to upload the thumbnail. This typically includes confirmation details about the upload operation or error information if the upload failed.
No binary data output is indicated by the source code or property definitions.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Platform.
- Depends on the iTwin Platform's iModels API being accessible.
- Uses an internal OpenAPI interpreter module to execute the API operation.
Troubleshooting
Common issues:
- Invalid or missing iModel ID: Ensure the "ID" property is correctly set to a valid iModel identifier.
- Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
- Incorrect custom payload format: If using the custom payload option, ensure the JSON is well-formed and matches the expected API schema.
Error messages:
"Unknown operation": Indicates the specified operation name does not match any supported operation. Confirm the operation is set to "upload-imodel-thumbnail".- API errors returned from the iTwin service will be passed through; check the error message for details such as permission denied or invalid input.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference, exact endpoint docs may be found here)