Table of properties of a schema definition
Name | Description | Type | Supported Values |
name | The name of this field. For example `id` or `created_at`. This should match the API name of the field | string | |
label | The label name of this field. For example 'ID' or 'Created at'. This is what you see in the recipe. | string | |
type | The data type of this field. Default value is string | string | string integer date_time boolean object array |
control_type | The input field type to expose in a recipe. | string | text text-area date date_time checkbox phone number url select |
hint | Hint to be added to a field (only shown as an input field | string | |
optional | Define whether this field is a required field (when being used as an input field). Defaults to false. | boolean | true false |
properties | Used to specify the contents of an array or object fields. | array | |
pick_list | List of name and value pairs for select control. Required when control_type is select E.g: "pick_list":[ ["Root","111390"], ["Recycle Bin","235611"] ] | array |
Sample schema
[ { "name": "status", "type": "string", "label": "Status", "control_type": "text" }, { "name": "birth_date", "type": "date_time", "label": "Birth date", "control_type": "date_time", "optional": true }, { "name": "gender", "type": "string", "label": "Gender", "control_type": "select", "pick_list": [ ["Male", "M"], ["Female", "F"] ] }, { "name":"contact_info", "type":"object", "label":"Contact information", "hint":"Phone number, email, etc", "properties":[ { "name": "phone", "type": "string", "label": "Phone", "control_type": "phone", "optional": true }, { "name": "email", "type": "string", "label": "Email address", "control_type": "email", "optional": true } ] } ]