Actions28
- Attachments Actions
- Comments Actions
- Import Actions
- Static Images Actions
- Forms Actions
- Delete form definition
- Update form definition metadata
- Get form definition by ID
- Add comment to form
- Get form data comments
- Download form as file
- Export forms to Storage
- Get form data details
- Update form data
- Delete form data
- Import form definition from another iTwin
- Get iTwin form definitions
- Add attachment to form
- Get form data attachments
- Create form data
- Get iTwin form data
- Get audit trail for form data
- List Groups Actions
- Templates Actions
- Workflows Actions
Overview
This node integrates with the iTwin Forms API, allowing users to interact with form definitions and their associated static images. Specifically, the "Get static image" operation retrieves a static image related to a particular form definition by specifying its ID and the image's file ID.
Common scenarios for this node include:
- Fetching visual representations of forms for documentation or review.
- Automating workflows that require embedding or processing form images.
- Archiving or exporting form visuals as part of a larger data pipeline.
For example, a user might use this node to retrieve a static image of a form layout to display it in a dashboard or send it via email.
Properties
| Name | Meaning |
|---|---|
| ID | The ID of the form definition for which to get a static image. |
| File ID | The ID of the specific static image file to retrieve. |
Output
The node outputs JSON data representing the retrieved static image information. The exact structure depends on the API response but typically includes metadata about the image and possibly the image content or a URL to access it.
If the image data is binary (e.g., raw image bytes), it would be provided in the binary output field, enabling further processing or saving within n8n workflows.
Dependencies
- Requires an API key credential for authenticating with the iTwin Forms API.
- The node depends on the
FormsOpenApiInterpreterclass internally to handle API operations. - Proper configuration of the OAuth2 credentials for the iTwin platform is necessary.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error indicating an unknown operation. Ensure the operation name matches exactly "get-static-image".
- Missing required parameters: Both "ID" and "File ID" are mandatory. Omitting either will cause execution failure.
- API authentication errors: Invalid or expired API credentials will prevent successful calls. Refresh or reconfigure the API key or OAuth token.
- Network or API downtime: Temporary connectivity issues or API service interruptions can cause failures. Retry after some time or check network settings.
Links and References
- iTwin Developer Documentation
- Node documentation URL embedded in the node: https://developer.bentley.com/apis/