Edit

[POST] .../v1/documentenumerator/edit

Edits a document enumerator. Use this method to change the numbering mask for a document type after retrieving the target enumerator with DocumentEnumerator/Get. The method updates sys_db_counters_ref.tbc_mask for the selected enumerator, writes an edit action log record and returns row_affected. The request body is required; id must identify an existing document enumerator, mask is required, mask length is limited by the database column to 50 characters and the mask must contain the counter placeholder. The current request user must have document enumerator edit permission and the document enumerator tariff parameter must be enabled. Missing body, invalid id, missing mask, mask without counter, denied access, disabled tariff parameter, missing record, transaction failures, action log failures and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Request Example

{
  "id": 5,
  "mask": "PUR-{y}-{counter}"
}

Response Parameters

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}