Unlock a locked file
Tenant Administrators may use POST /api/bom/v1/lock/{fileVersionId}/actions/release-file-lock to unlock the file specified in fileVersionId. All others may unlock a file if they are the owner.
Request schema
| Method | URL |
|---|---|
| POST | /api/bom/v1/lock/{fileVersionId}/actions/release-file-lock |
Request header
*indicates mandatory parameters.
| Field | Value type | Description |
|---|---|---|
*Authorization |
String | Enter: Bearer access token. |
*fileVersionId |
Integer | Enter the ID of the file version you want to unlock. Use GET /api/bom/v2/file-versions to get this value. |
*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. |
Response schema
Successful requests return a 200-HTTP response code.
The following HTTP error codes return the response detailed below:
| HTTP code | Description |
|---|---|
| 400 | Bad Request |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 410 | Gone (unavailable target) |
| 420 | Exceeded request limit |
| 422 | Processable entity |
| 500 | Unfulfilled valid request |
Response body
| 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 |
Array | More information about the error. |
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. |