Skip to main content

JSON Representation

Objects are exchanged as JSON. Each value data type has a defined representation in request and response bodies, and relations are encoded as URIs rather than embedded objects.

TODO

This page is a stub. Document, per value data type, how a value appears in JSON on the way in (request) and out (response), including:

  • Scalar types — TEXT, INTEGER, DECIMAL, CURRENCY, PERCENTAGE, BOOLEAN, DATE, DATETIME, etc. (string vs. number, date formatting, precision).
  • FILE and other binary-backed types, and how they relate to the upload/download URIs.
  • LIST-typed fields and how list keys are represented.
  • Relations — single-valued relation fields as singular-name URIs (e.g. "country": "/data/{tenant}/countries/{id}"), and multi-valued relations. Cross-link to Data › URL structure.
  • null / absent-value semantics, and any difference between a field being null versus omitted.