iTwin iModels

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

Actions54

Resource Actions
- Get iTwin iModels
- Delete iModel
- Get iModel
- Update iModel
- Create iModel
Userpermissions Actions
- Update iModel User Permissions
- Get iModel User Permissions
Baselinefile Actions
- Complete iModel Baseline File Upload
- Get iModel Baseline File Details
Locks Actions
- Get iModel Locks
- Update iModel Locks
Briefcases Actions
- Get iModel Briefcase
- Release iModel Briefcase
- Acquire iModel Briefcase
- Get iModel Briefcases
Checkpoint Actions
- Get Named Version Checkpoint
- Update Named Version Checkpoint
- Get Briefcase Checkpoint
- Get Changeset Checkpoint
Thumbnail Actions
- Upload iModel Thumbnail
- Download iModel Thumbnail
Extendeddata Actions
- Create Changeset Extended Data
- Get Changeset Extended Data
- Get Changesets Extended Data
Changesets Actions
- Create iModel Changeset
- Get iModel Changesets
- Get iModel Changeset
- Update iModel Changeset
Changesetgroups Actions
- Update iModel Changeset Group
- Get iModel Changeset Group
- Create iModel Changeset Group
- Get iModel Changeset Groups
Permissions Actions
- Get iModel Permissions
Recents Actions
- Get My Recently Used iTwin iModels
- Add iModel to My Recents
Namedversions Actions
- Get iModel Named Versions
- Create iModel Named Version
- Get iModel Named Version
- Update iModel Named Version
Shares Actions
- Get iModel Shares
- Create iModel Share
- Update iModel Share
- Revoke iModel Share
- Get iModel Share
Rolepermissions Actions
- Update iModel Role Permissions
- Get iModel Role Permissions
Users Actions
- Get iModel Users
- Get iModel User
Favorites Actions
- Add iModel to My Favorites
- Remove iModel from My Favorites
- Get My Favorite iTwin iModels
Fork Actions
- Fork iModel
Clone Actions
- Clone iModel
Create Actions
- Get Create iModel Operation Details

Overview

This node interacts with the iTwin Platform's iModels API, specifically to create extended data associated with a changeset in an iModel. It allows users to attach application-specific JSON data (encoded as a base64 string) to a particular changeset within an iModel. This is useful for scenarios where additional metadata or custom information needs to be stored alongside changesets, such as tracking deployment details, annotations, or integration data.

Practical examples include:

Attaching build or deployment metadata to a changeset for traceability.
Storing custom validation results or audit information related to a changeset.
Embedding project-specific notes or tags that are not part of the standard iModel schema.

Properties

Name	Meaning
ID	The unique identifier of the iModel to which the changeset belongs.
Changeset	The identifier or index of the changeset within the iModel to which the extended data will be attached.
Data	A base64-encoded string representing a valid JSON object containing application-specific data. Maximum size supported is 204,800 bytes.
Options	Additional options for the request: - Custom Payload: Allows overriding the default request body with a user-defined JSON payload.

Output

The node outputs JSON data representing the response from the iTwin Platform API after creating the extended data for the specified changeset. The exact structure depends on the API response but generally includes confirmation of the created extended data entry or any relevant metadata returned by the service.

No binary data output is indicated.

Dependencies

Requires an API authentication token credential configured in n8n to authenticate requests against the iTwin Platform API.
Depends on the iTwin Platform's iModels API being accessible and the user having appropriate permissions to modify changeset extended data.
Uses an internal OpenAPI interpreter module to map operations and execute API calls.

Troubleshooting

Common issues:
- Invalid or missing iModel ID or changeset identifier can cause errors.
- Providing improperly encoded or invalid JSON data in the Data property may result in request failures.
- Exceeding the maximum allowed size (204,800 bytes) for the base64-encoded data will likely cause errors.
- Insufficient permissions or expired API tokens can lead to authentication errors.
Error messages:
- "Unknown operation": Indicates the specified operation name is not recognized; ensure "create-imodel-changeset-extended-data" is correctly set.
- API errors related to invalid input or authorization will be passed through; check credentials and input formatting.
Resolution tips:
- Verify all required fields (ID, Changeset, Data) are correctly provided.
- Ensure the JSON data is valid before encoding it to base64.
- Refresh or reconfigure API credentials if authentication errors occur.
- Use the "Custom Payload" option only if you need to override the default request body and ensure the custom JSON is valid.