Logo

FieldDeclaration Data Type

Declaration of a field that can be extracted.

Properties
name data type constraints description
fieldId number required int Unique id of the field.
name string   Name of the field.
type string   Type of the field (one of int, amount, date, string, phrase).
required boolean required boolean Flag that indicates whether this field is required or not.
format string  
constant string   Constant associated with the field (optional).

Example

{
  "fieldId" : 12345,
  "name" : "...",
  "type" : "...",
  "required" : true,
  "format" : "...",
  "constant" : "..."
}