DocumentFieldEditDto

Endpoints · All schemas

Field	Required	Description
action	Yes	See definition below
lineId	No	Recognized line supporting the value
recognizedText	No	The recognized text of that line the caller read
revision	No	Revision of the existing decision, if there is one
value	No	The value, for confirm and 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"
    },
    "lineId": {
      "description": "Recognized line supporting the value",
      "format": "uuid",
      "nullable": true,
      "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 of that line the caller read",
      "type": "string"
    },
    "revision": {
      "description": "Revision of the existing decision, if there is one",
      "maximum": 9007199254740991,
      "minimum": 1,
      "nullable": true,
      "type": "integer"
    },
    "value": {
      "description": "The value, for confirm and correct",
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "action"
  ],
  "type": "object"
}