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 retrieve information about a named version checkpoint within an iModel. It is useful when you need to fetch detailed data about a particular checkpoint associated with a named version in an iModel, such as for auditing, version tracking, or integration with other systems that rely on iModel versioning.
A practical example would be automating the retrieval of checkpoint details to verify the state of an iModel at a specific named version before triggering downstream processes like deployments or reporting.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel from which to get the checkpoint. |
| Named Version ID | The unique identifier of the named version whose checkpoint is requested. |
Output
The output is a JSON object representing the checkpoint data retrieved from the iTwin Platform API. This typically includes metadata and details about the checkpoint corresponding to the specified named version within the given iModel.
If multiple results are returned (though unlikely for this operation), each will be output as separate JSON objects in the output array.
No binary data output is indicated by the source code.
Dependencies
- Requires an API authentication token credential configured in n8n to access the iTwin Platform API.
- Depends on the bundled
IModelsOpenApiInterpretermodule to interpret and execute API operations. - Network connectivity to the iTwin Platform API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or Named Version ID parameters will cause the operation to fail.
- Authentication errors if the API key or OAuth2 credentials are not properly configured.
- Network or API availability issues may result in request failures.
Error messages:
"Unknown operation: <operation>": Indicates the specified operation name is not recognized; ensure "get-named-version-checkpoint" is correctly set.- API errors returned from the iTwin Platform will be surfaced; check the error message for details.
Resolution tips:
- Verify that both the iModel ID and Named Version ID are correct and exist in your iTwin environment.
- Ensure the API credentials are valid and have sufficient permissions.
- Use the node’s "Continue On Fail" option to handle errors gracefully during batch executions.
Links and References
- iTwin Platform Developer Documentation
- Named Versions and Checkpoints Concepts (general reference)