Unlock a locked item

The item's owner and Tenant Administrators can unlock an item using POST /api/bom/v1/lock/{itemVersionId}/actions/release-item-lock.

Request schema

Method	URL
POST	`/api/bom/v1/lock/{itemVersionId}/actions/release-item-lock`

*indicates mandatory parameters.

Field	Value type	Description
*`Authorization`	String	Enter: Bearer access token.
*`itemVersionId`	Integer	Enter the ID of the item version you want to unlock. To get an item ID number: In the Upchain web app, open the BOM section of the project. Select the item in the BOM table to open its details pane. The item's ID number is the value shown beside `previewItem=` in the URL.
*`Upc-Selected-Company`	Integer	Company’s ID. Use the value returned in the `id` field received in response to the following request: `GET /api/auth/v1/companies`.
`X-User-Id`	Text	Enter the email address of the user being impersonated. This value is required if you are using a two-legged token. If you are using a three-legged token, then this field is not required.

A successful request to unlocks the item and returns an empty 200-HTTP response code.

The following HTTP error codes return the response detailed below:

Field	Value Type	Description
`message`	String	Details why the object could not be unlocked.
`instance`	String	Universally unique Id (UUID) for this issue.
`title`	String	Brief summary of the issue.
`titleKey`	String	Unique key composed of human-readable, language-agnostic, characters that represent this issue.
`errors`	String	Array of error-related details.
`errors.detail`	String	Human-readable description of the issue.
`errors.detailKey`	String	Unique key composed of human-readable, language-agnostic, characters that represent this issue.
`errors.detailKeyParameters`	String	Array of strings, each string being the value of a parameter in the detailKey.
`errors.fields`	String	Array of strings, each string being the identifier of a field related to this specific error.