Xceptor · Schema

FieldDefinition

A field definition within an extraction template

API IntegrationData AutomationData ExtractionDocument ProcessingETLFinancial DataFinancial ServicesIntelligent Document ProcessingReconciliationsTrade Operations

Properties

Name	Type	Description
name	string	The name of the field to extract
data_type	string	The expected data type of the field
required	boolean	Whether the field is required in the extraction output
validation_pattern	string	A regular expression pattern for validating extracted values

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldDefinition",
  "title": "FieldDefinition",
  "type": "object",
  "description": "A field definition within an extraction template",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the field to extract"
    },
    "data_type": {
      "type": "string",
      "description": "The expected data type of the field",
      "enum": [
        "string",
        "number",
        "date",
        "currency",
        "boolean"
      ]
    },
    "required": {
      "type": "boolean",
      "description": "Whether the field is required in the extraction output"
    },
    "validation_pattern": {
      "type": "string",
      "description": "A regular expression pattern for validating extracted values"
    }
  }
}