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 to acquire an iModel briefcase. Acquiring a briefcase is a common operation when working with iModels, which are digital representations of infrastructure projects. The briefcase acts as a local copy or workspace for an iModel on a specific device, enabling users to work offline or manage changes before syncing back to the platform.
Typical use cases include:
- Downloading an iModel briefcase to a device for offline editing.
- Managing multiple devices holding briefcases for collaboration.
- Automating workflows that require programmatic acquisition of briefcases.
For example, a user might automate acquiring a briefcase for a construction project’s iModel to prepare it for field engineers’ tablets.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel to acquire the briefcase from. |
| Device Name | The name of the device that will hold the acquired briefcase. |
| Options | Additional options for the request: |
| Custom Payload | Allows overriding the default request body with a custom JSON payload if enabled. |
The Options > Custom Payload property lets advanced users send a fully customized JSON body instead of the standard parameters, useful for special API requirements or testing.
Output
The node outputs JSON data representing the result of the briefcase acquisition operation. This typically includes details about the acquired briefcase such as its ID, status, and metadata returned by the iTwin API.
If the operation returns multiple objects, each is output as a separate JSON item in the array.
No binary data output is indicated in the source code.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2-based).
- Depends on the iTwin Platform's REST API for managing iModels and briefcases.
- Uses an internal OpenAPI interpreter module to execute operations against the iTwin API.
Troubleshooting
Common issues:
- Invalid or missing iModel ID: Ensure the "ID" property is correctly set to a valid iModel identifier.
- Authentication errors: Verify that the API key or OAuth2 credentials are properly configured and have sufficient permissions.
- Network or API availability problems: Check connectivity to the iTwin Platform and API status.
Error messages:
"Unknown operation: acquire-imodel-briefcase": Indicates the operation name is not recognized; ensure the correct operation is selected.- API errors returned from the platform will be surfaced in the node output under an error property if "Continue On Fail" is enabled.
Links and References
This summary is based solely on static analysis of the provided source code and property definitions.