6.1. Supported data types

Data typeExamplesRemarks
String"This is a string."Limited to 1048576 characters.
Date

"2013-09-23"

"October 1, 2013"

See http://www.php.net/manual/en/datetime.formats.php for supported formats.
Time"23:25:00" "4PM"See http://www.php.net/manual/en/datetime.formats.php for supported formats.
Date and time"2013-09-23, 16:00:00" "October 1, 2013, 4PM"See http://www.php.net/manual/en/datetime.formats.php for supported formats
Yes/No1 "true"Boolean type: 1, "true", "on", and "yes" resolve to true, all other values resolve to false.
Number42Signed integer number.
Decimal Number3.1415Real number with decimal point.


Request data are validated against the defined types, and the REST API will return an error when validation fails. The X-Deployteq-API-Error will contain more information on the offending data.

6.2. Data model example documentation

When the documentation for the model described in this manual is requested from the API, the following information is returned.

Extended data model description for brand Example 

Table: customer 

This is a system table which has no directly accessible data.

Defined relations

  • Table customer contains one or more entries from table order

Table: order

Defined columns

NameTypeDescription
addressstring
remarksstring
deliveredboolean

Defined relations

  • Table order contains one or more entries from table orderedpizza
  • Table customer contains one or more entries from table order

Table: orderedpizza

Defined columns

NameTypeDescription
pizzastring
numbernumber
remarksstring

Defined relations

  • Table order contains one or more entries from table orderedpizza
  • Column pizza in table orderedpizza refers to column name in table pizza

Table: pizza

Defined columns

NameType

Description

namestring

Defined columns

  • Column pizza in table orderedpizza refers to column name in table pizza