Fields in Vizydrop denote either user-supplied fields or fields within an information schema. There are various types of fields that each represent a different type of data. Fields are also used internally to denote information both required and optional for accounts and filters.
The table below lists the types of fields referred to in the Vizydrop app REST API. The first column denotes the string name of the type as expected in the API, the second column the type of underlying data, the third column any comments and remarks for each field type and the last one show additional options that may be specified.
|type||datatype||comments and remarks||Additional options|
|number||number||can be decimal, integer, or float||-|
|bool||boolean||validates as true/false||-|
|password||string||only used in account schemas, rendered as a password input||-|
|link||- (used for view)||show link to external source||Need to specify "value" field. It should contain link, for example "http://test.com".|
|highlightText||string||text with syntax highlight (json and sql supported for now)||Need to specify "editorMode" field. For now "json" and "sql" are supported.|
|oauth||- (used for view)||display Vizydrop Oauth form||-|
|list||variant||allows to select value from multiple options||Optional "datalist_requires" can be specified. For example "datalist_requires" = ["owner"] means that fetching the list depends on "owner" field.|
|multidropdown||Array||allows to select multiple values from dropdown list||Optional "datalist_requires" can be specified. For example "datalist_requires" = ["owner"] means that fetching the list depends on "owner" field.|
A Special Note on Dates
Dates, both with and without times, that are parsed as a result of user-input (through the Date range grammar) are
timezone-naive objects. Dates received from connected applications may be either aware or naive of timezones and should represent those dates as strings in an ISO-8601 format.