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 to create a new Changeset for an iModel. A Changeset represents a set of changes made to an iModel, such as updates to spatial data, definitions, or views. This operation is useful in scenarios where you want to programmatically track and manage incremental changes to digital twins or infrastructure models hosted on the iTwin platform.
Practical examples include:
- Automating the upload of changesets after modifications in a CAD or BIM tool.
- Integrating iModel version control into CI/CD pipelines for infrastructure projects.
- Managing synchronization metadata when multiple users or systems collaborate on the same iModel.
Properties
| Name | Meaning |
|---|---|
| ID (iModel id) | The unique identifier of the iModel to which the changeset will be added. |
| ID (Changeset id) | The unique identifier for the new changeset being created. |
| Description | A textual description of the changeset, explaining what changes it contains or its purpose. |
| Parent ID | The identifier of the parent changeset from which this changeset derives, enabling version lineage tracking. |
| Briefcase ID | The identifier of the briefcase used to create the changeset; briefcases represent working copies or sessions in the iModel ecosystem. |
| Group ID | Identifier of the Changeset Group that this changeset belongs to. This groups related changesets together. |
| File Size | The size in bytes of the changeset file being uploaded or referenced. |
| Containing Changes | Numeric flag indicating the types of changes contained in the changeset. Possible values: 0 (regular), 1 (schema), 2 (definition), 4 (spatial data), 8 (sheets and drawings), 16 (views and models), 32 (global properties). These flags can be combined except for schema. |
| Synchronization Info | JSON object containing synchronization-related metadata set by applications performing iModel synchronization. |
| Options → Custom Payload | Optionally override the entire request body with a custom JSON payload, allowing advanced users to send arbitrary data structures directly to the API. |
Output
The node outputs a JSON object representing the newly created changeset as returned by the iTwin iModels API. This typically includes all properties of the changeset such as its ID, description, parent ID, briefcase ID, file size, change types, synchronization info, and any other metadata provided by the API response.
No binary data output is produced by this operation.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Platform APIs.
- Depends on the iTwin iModels API service being accessible and the user having appropriate permissions to create changesets.
- The node internally uses an OpenAPI interpreter module to map operations and execute requests.
Troubleshooting
Common issues:
- Missing required parameters like iModel ID, changeset ID, briefcase ID, or file size will cause errors.
- Invalid or expired API credentials will result in authentication failures.
- Providing an invalid parent ID or group ID may cause the API to reject the request.
- Incorrectly formatted JSON in the Synchronization Info or Custom Payload fields can cause parsing errors.
Error messages:
"Unknown operation": Indicates the specified operation name is not recognized; ensure "create-imodel-changeset" is selected.- API errors related to authorization or permissions usually indicate missing or invalid API keys.
- Validation errors from the API often specify which required field is missing or malformed.
Resolution tips:
- Double-check all required fields are filled correctly.
- Validate JSON syntax in JSON-type fields before execution.
- Ensure API credentials are valid and have sufficient scope.
- Use the Custom Payload option only if you understand the API schema fully.