Field Types

​

string (default)

A property that should be stored and read as a basic string.

{
  "key": "currency",
  "label": "Product Code",
  "type": "string"
},

​

number

A property that should be stored and read as either an integer or floating point number. Database engines should look at the configuration to determine ideal storage format.

  {
    "key": "price",
    "label": "Retail Price",
    "type": "number",
    "config": {
      "decimal_places": 2
    }
  },

​

reference

Defines a reference to another sheet. Links should be established automatically by the matching engine or similar upon an evaluation of unique or similar columns between datasets.

​

enum

Defines an enumerated list of options for the user to select from. Matching tooling attempts to resolve incoming data assignment to a valid option. The maximum number of options for this list is 100. For larger lists, users should use the reference or future lookup types.

{
  "key": "status",
  "label": "Status",
  "type": "enum",
  "config": {
    "options": [
      {
        "value": "active"
      },
      {
        "value": "inactive",
        "label": "Disabled",
        "color": "#ff0000",
        "icon": "fa fa-ban",
        "meta": {
          "foo": "bar"
        }
      }
    ]
  }
},

​

boolean

A true or false value type. Matching engines should attempt to resolve all common ways of representing this value and it should usually be displayed as a checkbox.

{
  "key": "is_active",
  "label": "Active",
  "type": "boolean"
}

​

date

Store a field as a GMT date. Data hooks must convert this value into a YYYY-MM-DD format in order for it to be considered a valid value. Datetime is not currently available, but will be a separately supported Field Type in the future, and will include timezone.