Actions27
- Comments Actions
- List Groups Actions
- Static Images Actions
- Issues Actions
- Workflows Actions
- Attachments Actions
- Form Definitions Actions
- Import Actions
Overview
The "Download issue as file" operation in the iTwin Issues node allows users to download a specific issue from the iTwin Issues system as a file, primarily in PDF format. This is useful for scenarios where users need to archive, share, or review issue details offline or outside of the iTwin platform. For example, project managers might download issue reports to include in project documentation or distribute to stakeholders who do not have direct access to the iTwin system.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the issue to be downloaded as a file. |
| File Type | The type of file to download; currently, only "PDF" is supported. |
| Include Header | Boolean flag indicating whether to include form metadata (header) at the top of each PDF page. Defaults to true. |
Output
The node outputs the downloaded issue file data. The main output field json will contain metadata about the downloaded file or the result of the download operation. If the node supports binary data output (not explicitly shown in the provided code), it would represent the actual file content (e.g., the PDF file bytes). This enables further processing or saving of the file within an n8n workflow.
Dependencies
- Requires an API key credential for authenticating with the iTwin platform's OAuth2-based API.
- Depends on the iTwin Issues API endpoint to fetch and download issue files.
- Uses internal utility modules for making authenticated HTTP requests to the iTwin API.
- Requires proper configuration of the iTwin OAuth2 credentials in n8n.
Troubleshooting
Common issues:
- Providing an invalid or non-existent issue ID will likely cause the API request to fail.
- Specifying unsupported file types other than "PDF" may result in errors or no file being returned.
- Network or authentication failures can prevent successful downloads.
Error messages:
- Errors related to unsupported operations indicate that the requested operation is not implemented or recognized by the node.
- Authentication errors suggest misconfigured or expired API credentials.
- API response errors may include messages about missing permissions or invalid parameters.
Resolutions:
- Verify the issue ID is correct and exists in the iTwin system.
- Use only supported file types ("PDF").
- Ensure the API credentials are valid and have necessary permissions.
- Check network connectivity and API endpoint availability.
Links and References
- iTwin Developer Documentation
- iTwin Issues API Reference (general link, specific docs depend on Bentley's site structure)