Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


1.2.10 Domain object format

A domain refers to the storage location supported by JP1/OA. A domain object refers to a resource.

Supported data type

The following table describes the supported data types.

Type

Description

boolean

True or false

float

Floating-point decimal

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 format

To specify the date and time, use ISO 8601 format. In this format, you can omit all information except year (yyyy). If the date or time is omitted, the minimum value is automatically added. If the time zone is omitted, the time zone set for the JP1/OA server is the default.

Note, however, that you cannot omit the date and time if you use $query to specify them. If you get 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 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 an attribute is "ISO8601String," the year, month, date, time, and time zone display in the response body in the format shown in the following table:

Format

Example

Time processed by JP1/OA

yyyy-mm-ddThh:mm:ss.mmmTZD

2015-12-09T18:50:30.500+09:00

2015-12-09T18:50:30.500+09:00

yyyy-mm-ddThh:mm:ss.mmm

2015-12-09T18:50:30.500.000

2015-12-09T18:50:30.500.000[time-zone-of-the host-server]

yyyy-mm-ddThh:mm:ssTZD

2015-12-09T18:50:30+09:00

2015-12-09T18:50:30.000+09:00

yyyy-mm-ddThh:mmTZD

2015-12-09T18:50+09:00

2015-12-09T18:50:00.000+09:00

yyyy-mm-ddThhTZD

2015-12-09T18+09:00

2015-12-09T18:00:00.000+09:00

yyyy-mm-dd

2015-12-09

2015-12-09T00:00:00.000[time-zone-of-the host-server]

yyyy-mm

2015-12

2015-12-01T00:00:00.000[time-zone-of-the host-server]

yyyy

2015

2015-01-01T00:00:00.000[ time-zone-of-the host-server]