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 update an existing iModel Changeset. It allows users to modify metadata about a changeset such as its state and associated briefcase ID. This is useful in workflows where changesets are managed programmatically, for example:

  • Marking a changeset as having its file uploaded after processing.
  • Updating the briefcase ID that was used to create the changeset.
  • Customizing the request payload for advanced use cases.

Practical scenarios include automating version control of infrastructure models or synchronizing changeset states within a CI/CD pipeline for digital twins.

Properties

Name Meaning
ID The unique identifier of the iModel to which the changeset belongs.
Changeset ID The unique identifier of the changeset to update.
Briefcase ID Numeric ID of the briefcase used to create the changeset.
State The current state of the changeset. Options: "Waiting For File" or "File Uploaded". Should be set to "File Uploaded" once the changeset file is available.
Options Additional options including:
- Custom Payload: Override the default request body with a custom JSON payload. Useful for sending specialized data not covered by standard properties.

Output

The node outputs JSON objects representing the response from the iTwin iModels API after updating the changeset. The structure typically reflects the updated changeset resource, including fields like IDs and state.

If a custom payload is used, the output corresponds to whatever the API returns based on that payload.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the iTwin Platform (OAuth2-based).
  • Depends on the iTwin iModels API endpoint being accessible.
  • No additional environment variables are explicitly required beyond standard n8n credential setup.

Troubleshooting

  • Common Issues:

    • Invalid or missing iModel ID or Changeset ID will cause the API call to fail.
    • Setting an invalid state value outside the allowed options may result in errors.
    • Network connectivity issues or expired API tokens can cause authentication failures.
  • Error Messages:

    • "Unknown operation": Indicates the operation parameter is incorrect or unsupported.
    • API error responses related to authorization or resource not found should be checked against credentials and input IDs.
    • JSON parsing errors if using custom payloads with invalid JSON syntax.
  • Resolutions:

    • Verify all required IDs and parameters are correctly provided.
    • Ensure the OAuth2 credential is valid and has necessary scopes.
    • Validate JSON payloads before enabling custom payload option.

Links and References

Discussion