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 supporting operations related to managing iModel baseline files. The "Complete iModel Baseline File Upload" operation finalizes the upload process of a baseline file for a specified iModel. This is useful in workflows where users need to programmatically complete and confirm the upload of large or initial baseline files associated with digital twins or infrastructure models managed on the iTwin platform.

Practical examples include:

  • Automating the completion step after uploading a baseline file to ensure the iModel is ready for further processing.
  • Integrating with CI/CD pipelines that manage infrastructure model updates.
  • Building custom dashboards or tools that manage iModel lifecycle events.

Properties

Name Meaning
ID The unique identifier of the iModel for which the baseline file upload is being completed.
Options Additional options for the request:
  Custom Payload Allows overriding the default request body with a custom JSON payload. If enabled, the provided JSON will be sent as the request body instead of the standard one.

Output

The node outputs an array of JSON objects representing the response from the iTwin API after completing the baseline file upload. The exact structure depends on the API response but generally includes confirmation details about the completed upload.

If a custom payload is used, the output reflects the API's response to that payload.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Platform API.
  • Depends on the internal IModelsOpenApiInterpreter module to interpret and execute the API operation.
  • Network access to the iTwin Platform API endpoints is necessary.

Troubleshooting

  • Unknown operation error: If the operation name is incorrect or not supported, the node throws an error indicating "Unknown operation". Ensure the operation parameter is set exactly to "complete-imodel-baseline-file-upload".
  • API authentication failures: Missing or invalid API credentials will cause authentication errors. Verify that the API key or OAuth2 token is correctly configured.
  • Invalid iModel ID: Providing an incorrect or non-existent iModel ID may result in API errors. Confirm the ID is valid and accessible.
  • Malformed custom payload: If using the custom payload option, ensure the JSON is well-formed. Invalid JSON will cause parsing errors.
  • Continue on Fail: If enabled, the node will catch errors and output them as JSON objects instead of stopping execution, allowing workflows to handle errors gracefully.

Links and References

Discussion