Logo

FieldInfo Data Type

Container to carry field information.

Properties
name data type constraints description
fieldId number required int Id of the field as declared in FieldDeclaration.
location BoundingBox   Location of the field value on the document - only needs to be set for limited learning.
pageNumber number required int The fields page number
value string   Value of the field.

Either set a value or set word indexes.

Example

{
  "fieldId" : 12345,
  "location" : {
    "left" : 12345,
    "top" : 12345,
    "right" : 12345,
    "bottom" : 12345
  },
  "pageNumber" : 12345,
  "value" : "..."
}