iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more

Actions54

Overview

This node interacts with the iTwin Platform's iModels API, specifically to retrieve details about an iModel Baseline File. It is useful for users who need to fetch metadata or detailed information about a specific iModel baseline file by providing its unique identifier. Practical scenarios include integration workflows where you want to automate the retrieval of iModel baseline data for reporting, auditing, or further processing within a digital twin or infrastructure management system.

Properties

Name Meaning
ID The unique identifier of the iModel whose baseline file details you want to retrieve. This is a required string input.

Output

The node outputs JSON data containing the details of the requested iModel baseline file. The exact structure depends on the iTwin API response but typically includes metadata and properties describing the baseline file. If the operation returns multiple items, each will be output as a separate JSON object in the array. There is no indication that binary data is returned by this operation.

Dependencies

  • Requires an API authentication token credential configured in n8n to access the iTwin Platform API.
  • Depends on the iTwin Platform's iModels API being accessible and the provided iModel ID being valid.
  • Uses an internal interpreter module to map operations to API calls (bundled internally).

Troubleshooting

  • Common issues:

    • Providing an invalid or empty iModel ID will likely cause the API call to fail.
    • Missing or incorrect API authentication credentials will prevent successful communication with the iTwin API.
    • Network connectivity issues can cause timeouts or failures when calling the external API.
  • Error messages:

    • "Unknown operation: get-imodel-baseline-file-details": This would indicate a misconfiguration or typo in the operation name.
    • Errors from the API such as "Not Found" or "Unauthorized" usually mean the iModel ID does not exist or credentials are invalid.
  • Resolutions:

    • Verify the iModel ID is correct and exists in your iTwin environment.
    • Ensure the API key or OAuth2 credentials are properly set up and have sufficient permissions.
    • Check network connectivity and proxy settings if applicable.

Links and References

Discussion