6.3 Data types usable for an API

The following table lists and describes the data types usable for an API.

Table 6‒2: Data types usable for an API
Data type	Description
`boolean`	`true` or `false`
`int`	32-bit signed integer
`long`	64-bit signed integer
`string`^#	Text data

#: If you use a special character (such as a double quotation mark (") or backslash (\)) in JSON format, you need to escape such a character as shown in the following table.

Table 6‒3: List of characters that need to be escaped
Character	Escape notation
Double quotation mark (")	`\"`
Backslash (`\`)	`\\`
Backspace	`\b`
Form feed	`\f`
Line feed	`\n`
Carriage return	`\r`
Tab	`\t`
Unicode characters of 4-digit hexadecimal	`\uXXXX`

The date and time are displayed in the following format when they are specified or returned in the ISO 8601 format:

Format

YYYY-MM-DDThh:mm:ssTZD

Table 6‒4: Values that can be specified for the date and time
Notation	Description	Specifiable value
`YYYY`	Specify a year.	If the version of JP1/AJS3 - Web Console is 13-00 or later and the version of the connection-destination JP1/AJS3 - Manager is 13-00 or later: From `1994` to the four-digit year set for the `SCHEDULELIMIT` environment setting parameter of the connection-destination JP1/AJS3 - Manager^# In cases other than the above: 1994 to 2036
`MM`	Specify a month.	01 to 12
`DD`	Specify a day.	From `01` to the last day of the specified month
`Hh`	Specify hours.	00 to 23
`Mm`	Specify minutes.	00 to 59
`Ss`	Specify seconds.	00 to 59
`TZD`	Specify the time difference between the time on the manager host and UTC. For UTC, specify `Z`. For any cases other than UTC, specify the value in the format of `+hh:mm` or `-hh:mm`.	`Z`, `+hh:mm`, `-hh:mm`

#

For details about the SCHEDULELIMIT environment setting parameter of the connection-destination JP1/AJS3 - Manager, see 20.4.2(123) SCHEDULELIMIT in the JP1/Automatic Job Management System 3 Configuration Guide.

You can check the version of JP1/AJS3 - Web Console from the return value (productVersionNumber) of the version information acquisition API function. You can check the version of the connection-destination JP1/AJS3 - Manager from the return value (protocolVersionNumber) of the JP1/AJS3 - Manager protocol version acquisition API function.

For details about the version information acquisition API, see 7.1.37 Version information acquisition API.

For details about the JP1/AJS3 - Manager protocol version acquisition API, see 7.1.38 JP1/AJS3 - Manager protocol version acquisition API.

For example, if the UTC is January 16, 2015, 00:00:00 a.m., and the manager host uses Japan Standard Time, the time difference with UTC is +9 hours, so the value is 2015-01-16T09:00:00+09:00. If the manager host uses China Standard time, the time difference with UTC is +8 hours, so the value is 2015-01-16T08:00:00+08:00. If the manager host uses Eastern Standard Time, the time difference with UTC is -5 hours, so the value is 2015-01-15T19:00:00-05:00.

For a country or region where summer time is introduced, specify the date and time, considering the summer time. For example, if the UTC is April 16, 2015, 00:00:00 a.m., and the manager host uses Eastern Standard Time (daylight saving time), the time difference with UTC is -4 hours, so the value is 2015-04-15T20:00:00-04:00.

To Page Top