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 briefcases associated with a given iModel. Briefcases represent local copies of an iModel that users can acquire and work on offline. This operation is useful for managing and querying briefcases tied to a particular iModel, such as listing all briefcases, filtering by owner, or paginating through large sets of briefcases.
Practical examples include:
- Retrieving all briefcases for a specific iModel to monitor who has acquired it.
- Filtering briefcases owned by the current user to display their active working copies.
- Paginating through briefcases when there are many, using continuation tokens.
- Sorting briefcases by acquisition date to find the most recent ones.
Properties
| Name | Meaning |
|---|---|
| ID | The unique identifier of the iModel whose briefcases you want to retrieve. This is required. |
| Continuation Token | A token used to fetch the next page in a paginated response. It must be sent exactly as received from the service. To start using continuation tokens, provide an empty value initially. This parameter is mutually exclusive with the skip parameter (which is used by default). |
| Order By | Specifies the sorting order of the returned briefcases collection. You can sort by the acquiredDateTime property in ascending (asc) or descending (desc) order. If no keyword is specified, ascending order is assumed. Example: acquiredDateTime desc sorts by acquisition date descending. |
| Owner ID | Filters briefcases by their owner ID. Valid values are non-empty strings up to 255 characters. The special keyword me can be used to filter briefcases owned by the current authenticated user (the user associated with the access token). |
Output
The output is a JSON array where each item represents a briefcase object retrieved from the iModel. Each briefcase object contains properties describing the briefcase, such as its acquisition date, owner information, and other metadata provided by the iTwin API.
If multiple briefcases are returned, they appear as separate JSON objects within the output array.
No binary data output is indicated for this operation.
Dependencies
- Requires an API authentication token credential for the iTwin Platform (OAuth2).
- The node depends on the iTwin Platform's iModels API endpoint to fetch briefcase data.
- Proper configuration of the OAuth2 credentials in n8n is necessary to authenticate requests.
Troubleshooting
Common issues:
- Missing or invalid iModel ID will cause the request to fail.
- Incorrect or expired API authentication token will result in authorization errors.
- Using both continuation token and skip parameters simultaneously may cause unexpected behavior; only one should be used.
- Providing an invalid owner ID string (empty or too long) will lead to query errors.
Error messages:
"Unknown operation": Indicates the operation name was not recognized; ensure "Get iModel Briefcases" is selected.- Authorization errors typically indicate problems with the API key or OAuth2 token; re-authenticate or check permissions.
- Pagination errors may occur if the continuation token is malformed or expired; restart pagination with an empty token.
Links and References
- iTwin Platform Developer Documentation
- iModels API Reference (for detailed API parameters and responses)