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 new iModels within a specified iTwin. It is designed to facilitate the creation of digital representations (iModels) of infrastructure projects or assets, enabling users to manage spatial and project data programmatically.
Common scenarios where this node is beneficial include:
- Automating the setup of new iModels for different projects or phases.
- Integrating iModel creation into larger workflows that provision infrastructure digital twins.
- Creating iModels from templates, baselines, or empty states depending on project needs.
Practical example:
- A construction company automates the creation of an iModel for each new building project by providing the iTwin ID, name, description, geographic extent, and optionally a template or baseline file to initialize the model.
Properties
| Name | Meaning |
|---|---|
| iTwin ID | The identifier of the iTwin to which the created iModel will belong. |
| Name | The name assigned to the new iModel. |
| Description | Optional textual description of the iModel. |
| Extent | A JSON object defining a rectangular geographic area on Earth by specifying two latitudes and two longitudes representing the four sides of the rectangle. |
| Creation Mode | Specifies how the iModel should be created. Options are: - Empty: Creates an instantly initialized empty iModel. - Fromi Model Version: Creates from an existing iModel version. - From Baseline: Creates from a baseline file. |
| Template | JSON object specifying the iModel template to use during creation. |
| Baseline File | JSON object describing the baseline file used when creating the iModel. |
| Geographic Coordinate System | JSON object defining the Geographic Coordinate System (GCS) used by the iModel to maintain spatial consistency across synchronized data. |
| Options → Custom Payload | Allows overriding the entire request body with a custom JSON payload. This is useful for advanced use cases where the standard parameters do not cover all required fields. |
Output
The node outputs the response from the iTwin Platform API after attempting to create the iModel. The output is structured as JSON and typically contains details about the newly created iModel such as its ID, status, and metadata.
If multiple results are returned (e.g., in batch operations), each result is output as a separate JSON object in the array.
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 iModels API being accessible.
- Uses an internal interpreter module to map operations to API calls.
Troubleshooting
- Unknown operation error: If the operation parameter is set incorrectly or unsupported, the node throws an "Unknown operation" error. Ensure the operation is set to "Create iModel" under the correct resource.
- Invalid JSON in properties: Properties like
extent,template,baselineFile, andgeographicCoordinateSystemexpect valid JSON strings. Malformed JSON will cause parsing errors. Validate JSON syntax before input. - API authentication failures: Missing or invalid API credentials will prevent successful requests. Verify that the API key or OAuth2 token is correctly configured.
- Custom Payload misuse: When using the custom payload option, ensure the JSON fully conforms to the API schema; otherwise, the request may fail or produce unexpected results.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference for API endpoints and payloads)