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 allowing users to update an existing iModel. An iModel is a digital representation of infrastructure assets and their associated data. The "Update iModel" operation lets you modify properties such as the iModel's name, description, and geographical extent.
Common scenarios include:
- Renaming an iModel to reflect updated project phases.
- Adding or updating descriptive metadata for better identification.
- Adjusting the spatial extent to match changes in the modeled area.
Practical example:
You have an iModel representing a city infrastructure project. After expanding the project boundaries, you update the iModel's extent property to cover the new geographic area, ensuring all stakeholders work with the latest spatial data.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to update (required). |
| Name | New name for the iModel. |
| Description | New description text for the iModel. |
| Extent | A JSON object defining a rectangular geographic area on Earth by specifying two latitudes and two longitudes (the bounding box). |
| 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 where the default parameters are insufficient. |
Output
The node outputs JSON objects representing the updated iModel data returned from the API. This typically includes the updated properties of the iModel after the operation completes successfully.
If a custom payload is used, the output corresponds to whatever the API returns based on that payload.
No binary data output is produced by this node.
Dependencies
- Requires an API authentication token credential for the iTwin Platform.
- Needs network access to the iTwin Platform API endpoints.
- No additional external dependencies beyond the configured API credentials.
Troubleshooting
Common issues:
- Providing an invalid or non-existent iModel ID will cause the update to fail.
- Malformed JSON in the Extent or Custom Payload fields can cause request errors.
- Insufficient permissions or expired API tokens will result in authorization errors.
Error messages:
"Unknown operation": Indicates the specified operation is not supported; ensure "update-imodel" is selected.- API error responses related to invalid input or authentication will be passed through; check the message for details.
Resolutions:
- Verify the iModel ID exists and is correct.
- Validate JSON syntax before submitting.
- Refresh or reconfigure API credentials if authorization fails.
Links and References
- iTwin Platform API Documentation
- iModel Concepts Overview (general background on iModels)