iTwin Projects icon

iTwin Projects

Comprehensive iTwin Projects API

Overview

This node interacts with the "Exports" resource to retrieve details about a specific export job by its ID. It is useful in scenarios where you need to programmatically check the status or results of an export operation initiated elsewhere, such as exporting project data or reports. For example, after triggering an export job, you can use this node to poll and fetch the export's current state or download link.

Properties

Name Meaning
ID The unique identifier of the export job to retrieve. This is required to specify which export's details you want to get.

Output

The node outputs JSON data representing the export job's details. This typically includes information such as the export status, creation time, completion time, and possibly URLs or metadata related to the exported content. The exact structure depends on the external API's response but generally provides all relevant information about the specified export job.

If the export includes binary data (e.g., a file), it would be represented in the binary output field, allowing downstream nodes to handle or save the exported file.

Dependencies

  • Requires an API key credential or OAuth2 token configured in n8n to authenticate requests to the external service managing exports.
  • Depends on the external API endpoint that manages export jobs.
  • No additional environment variables are explicitly required beyond standard API authentication.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent export job ID will likely result in an error or empty response.
    • Authentication failures due to missing or incorrect API credentials.
    • Network connectivity problems when reaching the external API.
  • Error messages:

    • "Unknown operation: get-export": Indicates the operation name was not recognized; ensure the operation parameter is correctly set.
    • Errors related to authorization usually suggest checking the API key or OAuth token validity.
    • Timeout or network errors require verifying internet access and API availability.

Links and References

  • API Documentation — Official documentation for the iTwin Projects API, which likely includes details on export job management.

Discussion