iTwin iModels
Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more
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 to update a Named Version Checkpoint within an iModel. It allows users to modify checkpoint data associated with a particular named version of an iModel by sending either standard or custom JSON payloads to the API.
Common scenarios include:
- Updating metadata or properties of a checkpoint linked to a named version in an iModel.
- Customizing the request body for advanced use cases where the default payload structure does not suffice.
Practical example:
- A user wants to update the checkpoint details of a specific named version in their iModel project by providing the iModel ID and Named Version ID, optionally overriding the request body with a custom JSON payload to meet specific API requirements.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to which the checkpoint belongs. |
| Named Version ID | The unique identifier of the Named Version whose checkpoint is being updated. |
| Options | Additional options for the update operation: |
| - Custom Payload | Allows overriding the default request body with a custom JSON payload. If enabled, the node sends this custom JSON as the request body instead of the standard payload. |
Output
The node outputs JSON data representing the response from the iTwin Platform API after attempting to update the Named Version Checkpoint. This typically includes confirmation of the update or details about the updated checkpoint.
If a custom payload is used, the output reflects the API's response to that payload.
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 bundled
IModelsOpenApiInterpretermodule to interpret and execute API operations. - No additional external dependencies are required beyond the iTwin OAuth2 API credential.
Troubleshooting
Common issues:
- Providing invalid or missing iModel ID or Named Version ID will cause the API call to fail.
- Incorrectly formatted custom JSON payloads can lead to API errors.
- Network or authentication failures if the API key or OAuth token is misconfigured.
Error messages:
"Unknown operation: update-named-version-checkpoint": Indicates the operation name is incorrect or unsupported; verify the operation parameter.- API error responses will be included in the output JSON under an
errorproperty if "Continue On Fail" is enabled.
Resolutions:
- Ensure all required IDs are correctly specified.
- Validate custom JSON payload syntax before enabling it.
- Confirm that the API authentication credentials are properly set up and valid.