...
| Code Block |
|---|
{
"properties": {
...
"address": {
"city": {...},
"state": {...}
}
}
} |
Container-nodes can be nested.
The property "type": "node" isn't required (or recommended) but can be used for clarity.
Container-nodes can be nested.
...
If the "type", "required" and/or "description" properties are used, the sub-properties must be contained inside of the "items" property:
| Code Block |
|---|
{
"properties": {
...
"address": {
"type": "node",
"description": "Customer primary address",
"items": {
"city": {...},
"state": {...}
}
}
}
} |
| Property | Description |
|---|---|
required | A non-null value for this item must be provided (false by default). Items inside the container-node canoverride the parent container node's required setting. |
| items | Contains the list of sub-properties in the node. This is required only if the "type", "required" and/or "description" properties are used. |
| description | A human-readable description of the property. |
String
A string of characters variable. The following properties are applied when data is posted for this item:
| Property | Description |
|---|---|
min | Minimum string length. |
| Maximum string length. |
regex | String must match the regex pattern. |
default | If the item is not provided or is null, the default value is used. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Int
A numeric, whole number.
| Property | Description |
|---|---|
min | Minimum value allowed. |
| Maximum value allowed. |
default | If the item is not provided or is null, the default value is used. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Number
A numeric, decimal number with up to 15 bits of precision.
| Property | Description |
|---|---|
min | Minimum value allowed. |
| Maximum value allowed. |
default | If the item is not provided or is null, the default value is used. |
required | A non-null value for this item must be provided (false by default)(false by default). |
| description | A human-readable description of the property. |
Boolean
A Boolean, allowing only the two values of true or false
| Property | Description |
|---|---|
default | If the item is not provided or is null, the default value is used. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Enum
Enumerations (enums) can be either a primitive type (string, int, or a number) or, a cross-reference to an entire set or subset of data records in another domain.
| Property | Description |
|---|---|
enumType | Types of enums:
|
xrefLocation | If For example, if a version of a domain "countries"contains a list of data record values that represent all countries then a domain can reference it by specifying an enumeration type of
A subset of the data record values in the domain can be specified using the |
data | An array containing a comma separated list of enum values e.g.
Is a three-item string enumeration. If the
Assuming the display values for Canada, the United States and Mexico are those shown above in the data elements. |
default | If the item is not provided or is null, the default value is used. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
URI
A properly formed Uniform Resource Locator (URI). By default, a property of type uri can be any valid URI or it can be limited by a regex pattern or to a domain cross-reference (xrefLocation: "xref").
...
| Property | Description |
|---|---|
uriType | The uri type (e.g. url, blob, xref). |
| The location of the domain item or domain item data element. Used in conjunction with "uritype": "xref". |
regex | String must match the regex pattern. |
default | If the item is not provided or is null, the default value is used. |
required | A non null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Array
An array can contain any type of value including nodes and nested arrays.
| Property | Description |
|---|---|
minItems | Minimum items allowed in the array. |
| Maximum items allowed in the array |
default | If the item is not provided or is null, the default value is used. |
| items | Contains the list of sub-properties in the node. |
required | A non-null value for this item must be provided (false by default). |
| description | A human-readable description of the property. |
Rules About Required and Default Values
...