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 to create a Named Version for an iModel. A Named Version is a snapshot or milestone of an iModel at a specific changeset, useful for version control and tracking progress in digital twin projects.
Typical use cases include:
- Creating a baseline snapshot of an iModel before starting major changes.
- Marking significant milestones in the development or maintenance of infrastructure models.
- Automating version management workflows by programmatically creating named versions after changesets are committed.
For example, after committing a set of changes to an iModel, this node can be used to create a Named Version referencing that changeset, allowing teams to easily reference or revert to that state later.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which the Named Version will be created. |
| Name | The name of the Named Version to create. |
| Description | A textual description providing details about the Named Version. |
| Changeset ID | The identifier of the changeset that the Named Version will point to. If omitted, a baseline Named Version is created. |
| Options | Additional options including: - Custom Payload: Allows overriding the request body with a custom JSON payload. |
Details on Options > Custom Payload
- Use Custom Payload (boolean): Whether to override the standard request body with a custom JSON payload.
- JSON Payload (JSON): The custom JSON data to send as the request body if enabled.
Output
The node outputs JSON data representing the response from the iTwin Platform API after creating the Named Version. This typically includes details of the newly created Named Version such as its ID, name, description, associated changeset, timestamps, and other metadata.
No binary data output is indicated.
Dependencies
- Requires an API authentication token credential configured in n8n to authenticate with the iTwin Platform.
- Depends on the iTwin Platform's REST API for managing iModels and Named Versions.
- Uses an internal OpenAPI interpreter module to map operations and execute requests.
Troubleshooting
Common Issues:
- Missing or invalid iModel ID or changeset ID may cause API errors.
- Insufficient permissions or expired API tokens can lead to authentication failures.
- Providing an invalid custom JSON payload when using the custom payload option may result in malformed request errors.
Error Messages:
"Unknown operation": Indicates the specified operation is not recognized; ensure "create-imodel-named-version" is selected.- API error messages related to authorization or resource not found should be resolved by verifying credentials and input IDs.
- JSON parsing errors when using custom payloads suggest invalid JSON syntax; validate the JSON before submission.
Links and References
- iTwin Platform Developer Documentation
- Named Versions API Reference (general link, adjust based on actual API docs)