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 manage iModel briefcases. The "Release iModel Briefcase" operation allows users to release a checked-out briefcase associated with an iModel. This is useful in workflows where multiple users or systems collaborate on iModel data and need to ensure that briefcases are properly released after use to avoid conflicts or locking issues.
Practical examples include:
- Automating the release of briefcases after completing changes to an iModel.
- Integrating with CI/CD pipelines to manage iModel resources programmatically.
- Coordinating multi-user editing sessions by releasing briefcases when no longer needed.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to which the briefcase belongs. |
| Briefcase ID | The unique identifier of the briefcase to be released. |
Output
The node outputs JSON data representing the result of the release operation. The exact structure depends on the API response but generally includes confirmation of the briefcase release or relevant status information. If the operation returns multiple items, each will be output as separate JSON objects in the output array.
No binary data output is indicated for this operation.
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
Common Issues:
- Providing incorrect or missing iModel ID or briefcase ID will cause the operation to fail.
- Network connectivity issues or invalid API credentials can prevent successful execution.
- Attempting to release a briefcase that is not currently checked out or does not exist may result in errors.
Error Messages:
"Unknown operation: <operation>": Indicates the specified operation name is not recognized; verify the operation parameter.- API error messages related to authorization or resource not found should be checked against provided IDs and credentials.
Resolution Tips:
- Ensure all required parameters are correctly set.
- Verify that the OAuth2 credential is valid and has necessary permissions.
- Confirm the briefcase is currently checked out before attempting to release it.