Home / JSON Structure / Keywords

Main Keywords

Below you can find a list with all keywords, that can be used while creating a schema in the Q&B system.

Keyword Type Required in schema Description Values
label string No Title, that is shown above/before element in the quote form. Any possible characters (chars)
type string Yes Data type format according to the JSON schema specification. null, boolean, object, array, number, string
description string No General description of an element to help understand its purpose. Any text
default string No Default value, that is set in the element of quote form. Any text
authDefault string No By default sets entity or user ID. E.g., if you want a particular entity to be the default one in a quote form, then enter "authDefault": "entity.id" "authDefault": "entity.id" or "authDefault": ".id"
enum array No A list of the potential values for the element. Any text
$ref string No A reference to the external schema part as a separate JSON file. partName.json, where partName is the name of your additional JSON file, which contains the data referred to the root file
options array No This keyword allows to define multiple options for the drop-down lists, or the whole dataset. Any text
dependable object No Allows to create the dependance of a one element from another. Depending on the selected option, another field value will automatically fill in. target defines the affected field, parameter defines the field from a database, from where the information will be taken, options defines which database will be used. Any text
properties object No One of the main keywords, that defines of what the quote will be constructed. It can gather all the fields/buttons/tables, etc. Any text
uiType string Yes Defines which visual element will be shown on the quote form. See the uiTypes section
uiOptions object No A list of the potential UI options for the element. See the uiOptions section
uiRules object No A list of UI behavior rules. See the uiRules section
uiProperties object No A list of custom UI properties, values depends on separate UI elements. Various uiTypes and uiOptions
uiMapping object No Maps the information to the quote from other sources. It is required to define quoteField in the uiOptions. Any key:value pair
validationRules array No Defines that a custom message must be mapped to a certain rule of validation. 
    
"validationRules": [
  "required"  
],
validationMessages array No Allows a custom message to be mapped to a certain rule of validation. Possible message levels:
  • info - blue color (default if no level is set)
  • warning - yellow color
  • danger - red color
 
    
"validationMessages": [
  {
    "rule": "required",
    "message": "Your message",
    "level": "danger"
  } 
]
apiIntegrations object No An array of possible integration points. Has a unique key name. Applicable only to the root type element. See the apiIntegrations section