Actions26
- Repositories Actions
- Resource Actions
- Resources Actions
- Favorites Actions
- Exports Actions
- Image Actions
- Account Actions
- Graphics Actions
- Recents Actions
Overview
This node interacts with the iTwin Projects API to retrieve images associated with a specific iTwin. The "Get iTwin Image" operation fetches an image linked to a given iTwin ID. This is useful in scenarios where users want to programmatically access visual representations or snapshots related to their iTwin projects, such as for documentation, reporting, or integration into other workflows.
Practical examples include:
- Automatically retrieving and embedding iTwin images into project reports.
- Using the image data in dashboards or monitoring tools.
- Archiving visual states of iTwin projects at specific workflow points.
Properties
| Name | Meaning |
|---|---|
| iTwin ID | The unique identifier of the iTwin whose image you want to retrieve. |
Output
The node outputs JSON data representing the retrieved iTwin image. The exact structure depends on the API response but typically includes metadata about the image and possibly the image content or a URL to the image.
If the node supports binary data output (not explicitly shown in the provided code), it would represent the actual image file content, allowing further processing or saving within n8n workflows.
Dependencies
- Requires an API key credential for authenticating with the iTwin Projects API.
- Needs network access to the Bentley iTwin API endpoints.
- The node internally uses an interpreter module (
ProjectsOpenApiInterpreter) to handle API operations.
Troubleshooting
Common issues:
- Invalid or missing iTwin ID parameter will cause the operation to fail.
- Authentication errors if the API key credential is not configured correctly.
- Network connectivity problems can prevent successful API calls.
Error messages:
"Unknown operation: get-itwin-image"indicates the operation name might be misspelled or unsupported.- Errors mentioning failed API requests usually relate to authentication or invalid parameters.
Resolutions:
- Verify that the iTwin ID is correct and properly set.
- Ensure the API key credential is valid and has necessary permissions.
- Check network connectivity and API endpoint availability.
Links and References
- Bentley iTwin Developer Documentation
- Refer to the node's documentation URL for detailed usage instructions and examples.