iTwin Issues icon

iTwin Issues

iTwin Issues API for issue management, form definitions, attachments, and comments

Overview

The "Export issues to Storage" operation in the iTwin Issues node allows users to export selected issue instances from a project into a file stored in a specified folder within a storage system. This is particularly useful for archiving, sharing, or backing up issue data in a portable format such as PDF. For example, a project manager might export critical issues to PDF files and save them in a shared storage folder for review by stakeholders.

Properties

Name Meaning
Ids Instance IDs of issues to export. Must include at least 1 and no more than 5 IDs, separated by commas. All IDs must belong to the same project.
Include Header Boolean flag indicating whether to include metadata headers on top of each page when exporting to PDF. Defaults to true if not specified.
File Type The type of file to create for the export. Currently, only "PDF" is supported and is the default if not specified.
Folder ID The ID of the folder (retrieved from the Storage API) where the exported file should be saved. If not set, the file will be saved to the project's root folder by default.

Output

The node outputs JSON data representing the result of the export operation. This typically includes information about the exported file such as its location, name, or confirmation of successful storage. If binary data were involved (e.g., raw file content), it would be summarized accordingly, but here the output focuses on metadata about the stored export file.

Dependencies

  • Requires an API key credential for authenticating with the iTwin platform.
  • Depends on access to the iTwin Issues API and the Storage API to retrieve folder IDs and save files.
  • The node uses the iTwin OAuth2 authentication mechanism configured in n8n.
  • Network connectivity to Bentley's iTwin APIs is necessary.

Troubleshooting

  • Invalid or missing IDs: Ensure that the "Ids" property contains between 1 and 5 valid issue instance IDs from the same project. Errors may occur if IDs are malformed or belong to different projects.
  • Folder ID issues: If specifying a folder ID, verify that it exists and is accessible via the Storage API. Otherwise, the export will default to the project root folder.
  • Unsupported file types: Currently, only PDF exports are supported. Specifying other file types may cause errors.
  • Authentication failures: Confirm that the API key credential is correctly configured and has sufficient permissions.
  • API rate limits or network errors: These can cause export failures; retry or check network status.

Common error messages will relate to invalid parameters, authentication failures, or API request issues. Reviewing the error details and ensuring correct input values and credentials usually resolves these problems.

Links and References

Discussion