/
Schema - Types

Schema - Types

Owned by PIPEFORCE
Last updated: Nov 18, 2021Version comment
2 min read

Licenses

COMMUNITY, ENTERPRISE, CORPORATE

Since

VERSION 6.0

The type inside a JSON schema defines the data format of a field. Furthermore based on this type, form fields are rendered automatically in order to fit the defined format. The supported format types are:

Format

Configuration example

Description

Format

Configuration example

Description

Date

"myDate": { "type": "string", "format": "date" }

Meant for a single date.
Shows-up as date picker in the form.

Text

"myText": { "type": "string" }

Meant for small amount of text.
Shows-up as single-line input field in the form.

Single-List

"mySingleList": { "type": "string", "enum":["male", "female"] }

Meant for lists where only one element can be selected from.
Shows-up as single-select drop-down in the form.

Multi-List

"someMultiList": { "type": "array", "items": { "type": "string", "enum": ["item1", "item2"] } }

Meant for lists where multiple elements can be selected from.
Shows-up as multi-select drop-down in the form.

Yes/No

"myYesNo": { "type": "boolean" }

Meant for yes/no (true/false) values.
Shows-up as checkbox in the form.
You can set the attribute "render":"button" in the form config in order to display this as a clickable button instead of a checkbox.

Number

"myNumber": { "type": "number" }

Meant for number values.
Shows-up as number field in the form.

File

"myFile": { "type": "object", "properties": { "filename": {"type": "string"}, "contentLength": {"type": "number"}, "contentType": {"type": "string"}, "contentEncoding": {"type": "string"}, "content": {"type": "string"} } }

Meant for file attachments to an object.
In order to show-up in a form correctly, additionally you need to set "render":"filepicker" or "render":"pdfpreview" in the form configuration.

 

Related content