iTwin iModels icon

iTwin iModels

Interact with iTwin Platform iModels API for managing iModels, changesets, named versions, and more
Join our community

Actions54

Overview

This node interacts with the iTwin Platform's iModels API to retrieve lock information on a specified iModel. Specifically, the "Get iModel Locks" operation fetches details about locks held on an iModel, which is useful for understanding concurrent access and editing states within collaborative engineering or design projects.

Typical use cases include:

  • Monitoring who holds locks on parts of an iModel to coordinate work among multiple users.
  • Filtering locks by briefcase ID or lock level to analyze exclusive or shared locks.
  • Paginating through large sets of locks using continuation tokens.

For example, a user might query all exclusive locks on an iModel to identify locked objects that cannot be edited by others until released.

Properties

Name Meaning
ID The unique identifier of the iModel for which to retrieve locks. This is required.
Continuation Token A token used to retrieve 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. It is mutually exclusive with the skip parameter.
Briefcase ID Filters locks by the briefcase ID property, returning only locks associated with a specific Briefcase.
Lock Level Filters locks by their lock level. Valid values are "exclusive" (locks that prevent others from editing) or "shared" (locks that allow concurrent read access).

Output

The output is an array of JSON objects representing lock information retrieved from the iModel. Each object corresponds to a lock and contains details such as the locked object, lock level, briefcase ID, and other metadata provided by the iTwin Platform API.

No binary data output is produced by this node.

Dependencies

  • Requires an API authentication credential for the iTwin Platform (an OAuth2-based API key).
  • The node depends on the iTwin Platform's iModels API endpoint to fetch lock data.
  • No additional external services or environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Common issues:

    • Providing an invalid or expired iModel ID will result in errors or empty results.
    • Incorrect or missing API credentials will cause authentication failures.
    • Using both continuation token and skip parameters simultaneously may cause request errors.
    • Pagination tokens must be used exactly as returned; modifying them can lead to invalid requests.

  • Error messages:

    • "Unknown operation": Indicates the operation name was not recognized; ensure "get-imodel-locks" is selected.
    • Authentication errors typically indicate invalid or missing API credentials.
    • Errors related to pagination usually stem from incorrect usage of continuation tokens.

To resolve these, verify the correctness of input parameters, ensure valid API credentials are configured, and follow the pagination instructions carefully.

Links and References

Discussion