Lock

[POST] .../v1/doccommercialoffer/lock

Locks commercial offer documents for editing. Lock one or more commercial offer documents before editing headers or changing offer rows in workflows that follow the document lock contract. The request body must contain a non-empty ids array with positive document IDs and this method does not perform a separate RBAC permission check for Lock. Before locking, the method validates that every document exists and is not deleted or marked for deletion; the response reports how many document lock rows changed. Errors such as missing body, missing ids, invalid IDs, document not found, deleted or deletion-marked document, lock conflicts, storage errors or lock 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
  }
}