Share

Clear edit, checkout, BOM edit, and eBOM structural locks

As a Tenant Administrator, you can clear edit, checkout, BOM-edit, and eBOM structural locks on an item. This operation can be performed from one of three areas in Upchain:

  • BOM table or item details pane
  • Quick or Advanced search
  • Using the API
Important: The enable.configurations.solidworks tenant property must be disabled for this feature to work as described.

Clear item locks from the BOM table

  1. Navigate to the BOM section of the project that contains the locked item.
  2. Select an item from the navigation tree.
  3. Click More Actions more actions icon corresponding to the item for which you want to clear its lock.
  4. Select Admin > Clear lock.

You can also find the Clear lock option available in the item details pane > more actions button > Admin menu.

  1. In Upchain, complete a search operation either from Quick search or Advanced search.
  2. Select the item for which you want to clear its lock.
  3. In the item details pane, click More Actions more actions icon Admin > Clear lock.

The Tenant Administrator receives a confirmation dialog box. Click Unlock item to confirm that you want to remove the lock.

Important:
  • Edit locks are only removed for the item against which the Clear lock action was performed. Child-items will not be impacted.
  • If removing a BOM-edit lock for a parent-item, then locks are removed for its child-items as well.

Clear item locks using the API

Tenant Administrators can use DELETE ​/api​/lock​/v1​/item-versions​/{itemVersionId}​/locks to remove BOM-edit, edit, and checkout locks for the item specified in itemVersionId.

Note: DELETE /api/lock/v1/item-versions/{itemVersionId}/locks clears an item's edit lock and the checkout lock for any associated files. If this endpoint is used for any other lock types, then an error is returned.

A 200-http response returns information about all locks that were cleared.

Was this information helpful?