Skip to main content

CorrectionRule

An auto-correction applied to a field value before or after validation

ruleIdstringrequired

Unique identifier for this rule within the spec

Example: cr-001
fieldstringrequired

Name of the field to correct

Example: account_number
correctionTypeCorrectionType (string)required

Type of auto-correction to apply

Possible values: [TRIM, TRIM_LEADING, TRIM_TRAILING, UPPERCASE, LOWERCASE, TITLE_CASE, DATE_FORMAT_COERCE, NUMBER_FORMAT_COERCE, DEFAULT_IF_NULL, DEFAULT_IF_EMPTY, PAD_LEFT, PAD_RIGHT, REMOVE_SPECIAL_CHARS, REGEX_REPLACE]

Example: TRIM
valuestring

Correction parameter (e.g. default value, replacement string, pad character)

Example: 0
applyOrderinteger

Execution order when multiple corrections apply to the same field (lower = first)

Default value: 0
Example: 1
CorrectionRule
{
  "ruleId": "cr-001",
  "field": "account_number",
  "correctionType": "TRIM",
  "value": "0",
  "applyOrder": 1
}