Actions27
- Comments Actions
- List Groups Actions
- Static Images Actions
- Issues Actions
- Workflows Actions
- Attachments Actions
- Form Definitions Actions
- Import Actions
Overview
This node facilitates uploading an attachment file to a specific issue within the iTwin Issues system. It is designed for scenarios where users need to programmatically associate files (such as images, documents, or other relevant data) with existing issue records in the iTwin platform. For example, a project manager might use this node to attach design documents or screenshots to an issue directly from an automated workflow, improving traceability and collaboration.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the issue to which the attachment belongs. |
| Attachment ID | The unique identifier of the attachment metadata instance that this file will be associated with. |
| Options | Additional optional settings: |
| - Custom Payload | Allows overriding the default request body with a custom JSON payload. Useful for advanced or non-standard API requests. |
Output
The node outputs JSON data representing the response from the iTwin Issues API after attempting to upload the attachment file. This typically includes confirmation details about the uploaded attachment or error information if the upload failed.
No binary data output is indicated by the source code or properties; the node focuses on JSON responses related to attachment metadata and status.
Dependencies
- Requires an API key credential for authentication with the iTwin Issues API.
- Depends on the iTwin Issues REST API endpoint at
https://api.bentley.com. - Uses internal shared utilities for making authenticated HTTP requests.
- Requires proper configuration of the OAuth2 API credentials within n8n to authorize requests.
Troubleshooting
Common issues:
- Invalid or missing Issue ID or Attachment ID will cause the API request to fail.
- Authentication errors if the API key or OAuth token is not correctly configured.
- Network or permission issues when accessing the iTwin API endpoint.
Error messages:
- Errors returned from the API are captured and can be output as part of the node's JSON response if "Continue On Fail" is enabled.
- Typical errors include "Unsupported operation" if the operation parameter is incorrect, or HTTP errors indicating authorization failure or resource not found.
Resolutions:
- Verify that the Issue ID and Attachment ID are correct and correspond to existing resources.
- Ensure the API credentials are valid and have sufficient permissions.
- Check network connectivity and API endpoint availability.
Links and References
Note: The provided bundled source code does not explicitly show the detailed implementation of the "upload attachment file" operation but indicates the general pattern of constructing API requests and handling responses. The properties and their usage are derived from the supplied JSON property definitions.