21 DOMAIN TYPES RESOURCE
The domain types resource provides a list of all the domain types that are known to the system.
The endpoint URL for this resource is simply:
/domain-types/
21.2 Representation
The links from the typelist representation to other resources are as shown in the diagram below:
For example, the JSON representation of the list of domain types for a system looks something like:
{
"links" : [ {
"rel": "self",
"href" : "http://localhost:8080/domain-types",
"method" : "GET",
"type" : "application/json;profile=\".../type-list\""
}, {
"rel": "up",
"href": "http://~/", "type": "application/json;profile=\".../homepage\"",
"method": "GET"
} ],
"value" : [ {
"rel": ".../domain-type",
"href" : "http://~/domain-types/CUS",
"method" : "GET",
"type" : "application/json;profile=\".../domain-type\""
}, {
"rel": ".../domain-type",
"href" : "http://~/domain-types/ORD",
"method" : "GET",
"type" : "application/json; profile=\".../domain-type\""
}, ...
],
"extensions" : { ... }
}where:
| JSON-Property | Description |
|---|---|
links |
list of links to other resources. |
links[rel=self] |
link to a resource that can obtain this representation |
links[rel=up] |
link to the homepage resource, B§5. |
values |
List of links to domain types, §D22. |
extensions |
map of additional information about the resource. |
21.3 Predefined Domain Types
There are a number of predefined "formal" domain type resources that correspond either to the built-in scalar types described §A2.5, or to lists and sets (for collections), or to void (for actions with void return type).
The following table shows the correlation in these cases:
| Type | Simple scheme JSON datatype |
Simple scheme 'format' |
Formal scheme predefined type |
|---|---|---|---|
string |
String |
string |
|
boolean |
Boolean |
||
date-time |
String |
date-time |
|
date |
String |
date |
|
time |
String |
time |
|
epoch ms |
String |
utc-millisec |
|
big integer |
String |
big-integer(n) |
|
big decimal |
String |
big-decimal(s,p) |
|
blob |
String |
blob http |
://~/domain-types/blob |
clob |
String |
clob |
|
decimal |
Number |
decimal |
|
int |
Number |
integer |
|
list |
-- |
-- |
|
set |
-- |
-- |
|
void |
-- |
-- |
If the "format" json-property is omitted for a number, then the rules for interpreting that number as a float-point decimal or as an integer are as documented in the ECMAscript standard, §A2.5.
For large numbers, big-integer(n) specifies the scale n, while big-decimal(s,p) specifies the scale s and the precision p.
For example, big-integer(10) is numbers in the range 0 to 9,999,999,999, while big-decimal(10.2) is numbers in the range 0.00 to 99,999,999.99.
No representations are returned
No representations are defined for any of the predefined domain type resources listed above; instead, a 204 (no content) will be returned.
Clients are expected to have built-in support for these domain types (e.g. a calendar widget to render dates; a checkbox widget to render Booleans, and so on).