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 details about a particular iModel Briefcase. It is useful in scenarios where users need to fetch metadata or status information about a briefcase associated with an iModel, such as for synchronization, auditing, or management purposes.
Practical examples include:
- Retrieving the current state or properties of a briefcase before performing updates.
- Monitoring briefcase usage or ownership within a project.
- Integrating briefcase data into workflows that manage iModel lifecycle or collaboration.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel from which to get the briefcase details. |
| Briefcase ID | The numeric identifier of the specific briefcase within the iModel to retrieve details for. |
Output
The node outputs JSON data representing the details of the requested iModel Briefcase. This typically includes metadata and properties related to the briefcase, such as its ID, status, owner, and other relevant attributes as returned by the iTwin Platform API.
If the operation returns multiple objects (unlikely in this case), each will be output as a separate JSON item. No binary data output is indicated.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2-based).
- Depends on the iTwin Platform iModels API being accessible.
- Uses an internal OpenAPI interpreter module to execute the API calls.
Troubleshooting
Common issues:
- Invalid or missing iModel ID or Briefcase ID parameters will cause errors.
- Authentication failures if the API token is expired or misconfigured.
- Network or API endpoint unavailability can cause request failures.
Error messages:
"Unknown operation: ..."indicates an unsupported operation name was provided.- Errors containing
"iTwin IModels execution failed"suggest API call failures; check credentials and parameter correctness.
Resolutions:
- Verify that both the iModel ID and Briefcase ID are correctly specified and exist.
- Ensure the API authentication token is valid and has necessary permissions.
- Check network connectivity and API service status.