Skip to content

DocumentLineEditDto

Endpoints · All schemas

FieldRequiredDescription
actionYesSee definition below
ocrIdYesRecognized line the decision is about
recognizedTextYesThe recognized text the caller read; refused when it changed
revisionNoRevision of the existing decision, if there is one
valueNoThe corrected text, for correct

Complete definition

required lists fields that must be present. nullable allows a null value; it does not make the field optional. Response enums retain exact wire values for compatibility.

Field definitions: DocumentEditAction

{
  "properties": {
    "action": {
      "$ref": "#/components/schemas/DocumentEditAction"
    },
    "ocrId": {
      "description": "Recognized line the decision is about",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$",
      "type": "string"
    },
    "recognizedText": {
      "description": "The recognized text the caller read; refused when it changed",
      "type": "string"
    },
    "revision": {
      "description": "Revision of the existing decision, if there is one",
      "maximum": 9007199254740991,
      "minimum": 1,
      "nullable": true,
      "type": "integer"
    },
    "value": {
      "description": "The corrected text, for correct",
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "action",
    "ocrId",
    "recognizedText"
  ],
  "type": "object"
}