Schema - Validation Rules
- PIPEFORCE
Licenses | COMMUNITY, ENTERPRISE, CORPORATE |
Since | VERSION 6.0 |
It is also possible to define validation rules for fields inside a JSON Schema document.
Note: Currently, validation rules placed in the JSON Schema are not reflected automatically in the form. In order to validate the fields in a form, you have to use the layout section in the form configuration to define form rules. See Forms.
This will change in a future version of PIPEFORCE, so that validation rules in the JSON Schema will be converted automatically to form validation rules. You can vote for this feature by adding a comment to this page, if you want.
For a full documentation about the possible validation rules in JSON Schema, see the specification: https://json-schema.org/draft/2019-09/json-schema-core.html
https://json-schema.org/understanding-json-schema/
Here are some example validation rules.
Length
{
"type": "string",
"minLength": 2,
"maxLength": 3
}Valid: hi
Regular expression
{
"type": "string",
"pattern": "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$"
}Valid: 555-1212
Date and time
{
"type": "string",
"format": "date-time"
}Valid: 2018-11-13T20:20:39+00:00
Time (draft)
{
"type": "string",
"format": "time"
}Valid: 20:20:39+00:00
Date (draft)
{
"type": "string",
"format": "date"
}Valid: 2018-11-13
{
"type": "string",
"format": "email"
}Valid: my@email.de
Hostname
{
"type": "string",
"format": "hostname"
}Valid: google.com
Uri
{
"type": "string",
"format": "uri"
}Valid: https://google.com
Required fields
{
"type": "object",
"properties": {
"name": { "type": "string" },
"email": { "type": "string" },
"address": { "type": "string" },
"telephone": { "type": "string" }
},
"required": ["name", "email"]
}