Actions54
- Resource Actions
- Userpermissions Actions
- Baselinefile Actions
- Locks Actions
- Briefcases Actions
- Checkpoint Actions
- Thumbnail Actions
- Extendeddata Actions
- Changesets Actions
- Changesetgroups Actions
- Permissions Actions
- Recents Actions
- Namedversions Actions
- Shares Actions
- Rolepermissions Actions
- Users Actions
- Favorites Actions
- Fork Actions
- Clone Actions
- Create Actions
Overview
This node interacts with the iTwin Platform's iModels API, specifically to update a Named Version within an iModel. Named Versions are snapshots or bookmarks of an iModel at a particular state, useful for version control and collaboration in infrastructure digital twins.
The "Update iModel Named Version" operation allows users to modify properties of an existing Named Version such as its name, description, and visibility state. This is beneficial when you want to rename a snapshot, add descriptive metadata, or change whether it is visible or hidden in user interfaces.
Practical examples:
- Renaming a Named Version to reflect a milestone (e.g., "Pre-construction Review").
- Adding or updating a description to provide context about what the Named Version represents.
- Changing the visibility state to hide obsolete versions from users.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel containing the Named Version to update. |
| Named Version ID | The unique identifier of the Named Version to be updated. |
| Name | New name for the Named Version. |
| Description | New description text providing details about the Named Version. |
| State | Visibility state of the Named Version in the user interface. Options: hidden (not shown), visible (shown). |
| Options | Additional options including: |
| - Custom Payload | Allows overriding the request body with a custom JSON payload instead of using the standard fields. Useful for advanced use cases or unsupported API parameters. |
Output
The node outputs JSON data representing the updated Named Version object returned by the iTwin API. This typically includes the Named Version's identifiers, updated properties (name, description, state), timestamps, and other metadata.
No binary data output is involved.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Platform API.
- Uses the iTwin Platform OpenAPI interpreter internally to map operations and execute requests.
- Network connectivity to the iTwin Platform API endpoint.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or Named Version ID will cause the API call to fail.
- Insufficient permissions or expired API tokens can result in authorization errors.
- Providing malformed JSON in the custom payload option may cause request failures.
Error messages:
"Unknown operation: update-imodel-named-version": Indicates the operation parameter is incorrect or not supported.- API error responses related to invalid IDs or unauthorized access should be checked against credentials and input values.
Resolutions:
- Verify that the iModel ID and Named Version ID are correct and exist.
- Ensure the API key or OAuth token is valid and has necessary scopes.
- When using custom payloads, validate JSON syntax carefully before submission.