Unlock

[POST] .../v1/doccommercialoffer/unlock

Unlocks commercial offer document for editing. Use this method to unlock one or more commercial offer documents after an editing workflow finishes. The request requires the commercial offer unlock permission, the body must contain a non-empty ids array with positive document IDs and the persistent validates that every document exists and is not deleted or marked for deletion before unlocking. The response reports how many document lock rows changed and callers can verify document state with DocCommercialOffer/Get. Business errors such as missing body, missing ids, invalid IDs, denied access, document not found, deleted or deletion-marked document, lock ownership conflicts, database failures or persistent unlock errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
ids Array of Int64 Required Commercial offer document ID array.

Request Example

{
  "ids": [
    1
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "ids": [
      null
    ],
    "row_affected": 1
  }
}