9.2.12 Domain object format
A domain refers to the location in which resources supported by JP1/AO are stored. A domain object refers to a resource. This section describes the data format of members for resources.
Supported data type
The following table describes the data types supported by the JSON format and XML format.
|
Type name |
Description |
|---|---|
|
boolean |
true or false |
|
int |
32-bit signed integer |
|
long |
64-bit signed integer |
|
string# |
Text data |
- #
-
ISO8601String, URLString, and enum are extended expressions for the string type.
Date and time
The following describes how to specify the date and time for a domain object.
To specify the date and time, use ISO8601 format. In this format, you can omit all information except year (yyyy). If the date or time is omitted, the minimum specifiable value is automatically added. If the time zone is omitted, the time zone set for the JP1/AO server is set by default.
Note, however, that you cannot omit the date and time if you use HQL::filter to specify them. If you acquire time information in JSON format, the time is output in a format where a colon (:) is not used for time zone information (for example, 2014-12-09T18:50:30.500+0900). To specify the time information acquired in JSON format as an input for an API, add a colon (:) in the time zone (for example, 2014-12-09T18:50:30.500+09:00). If you do not add a colon (:), an error occurs.
If the data type of a member of a resource is ISO8601String, year, month, date, time, and time zone are displayed in the response body in yyyy-mmddThh:mm:ss.mmmTZD format.
|
Format |
Example |
Time processed by JP1/AO |
|---|---|---|
|
yyyy-mm-ddThh:mm:ss.mmmTZD |
2014-12-09T18:50:30.500+09:00 |
Same as the example. |
|
yyyy-mm-ddThh:mm:ss.mmm |
2014-12-09T18:50:30.500.000 |
2014-12-09T18:50:30.500.000[time-zone-of-the-host-server] |
|
yyyy-mm-ddThh:mm:ssTZD |
2014-12-09T18:50:30+09:00 |
2014-12-09T18:50:30.000+09:00 |
|
yyyy-mm-ddThh:mmTZD |
2014-12-09T18:50+09:00 |
2014-12-09T18:50:00.000+09:00 |
|
yyyy-mm-ddThhTZD |
2014-12-09T18+09:00 |
2014-12-09T18:00:00.000+09:00 |
|
yyyy-mm-dd |
2014-12-09 |
2014-12-09T00:00:00.000[time-zone-of-the-host-server] |
|
yyyy-mm |
2014-12 |
2014-12-01T00:00:00.000[time-zone-of-the-host-server] |
|
yyyy |
2014 |
2014-01-01T00:00:00.000[time-zone-of-the-host-server] |