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 briefcase checkpoint associated with an iModel. A briefcase checkpoint represents a saved state or snapshot of an iModel at a particular point in time, useful for synchronizing changes or managing versions.
Common scenarios where this node is beneficial include:
- Fetching the current checkpoint of a briefcase to determine the latest synchronized state.
- Managing workflows that require knowledge of the checkpoint ID for further operations like updates or synchronization.
- Integrating iModel data retrieval into automation pipelines for infrastructure or building digital twins.
For example, you might use this node to get the checkpoint ID of a specific iModel before applying changes or to verify the synchronization status in a CI/CD pipeline for infrastructure models.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel for which the briefcase checkpoint is to be retrieved. This is a required string input. |
Output
The node outputs JSON data representing the briefcase checkpoint details retrieved from the iTwin Platform API. The exact structure depends on the API response but typically includes properties such as checkpoint ID, change set information, and timestamps.
If multiple results are returned, each will be output as a separate JSON object in the output array.
No binary data output is indicated by the source code.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2-based).
- Depends on the iTwin Platform iModels API being accessible.
- The node uses an internal interpreter module (
IModelsOpenApiInterpreter) to map operations to API calls.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an "Unknown operation" error. Ensure the operation name matches exactly "get-briefcase-checkpoint".
- API authentication failures: Missing or invalid API credentials will cause authentication errors. Verify that the OAuth2 API key is correctly configured.
- Invalid or missing iModel ID: Providing an empty or incorrect iModel ID will result in API errors or no data returned. Confirm the ID is valid and exists in your iTwin environment.
- Network or API downtime: Connectivity issues with the iTwin Platform API can cause request failures. Check network connectivity and API status.
The node supports continuing on failure if enabled, allowing workflows to proceed even if some executions fail.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (general reference for iModel operations)