Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.2.6 Response format

The following shows the response format.

Figure 2‒2: Response format

[Figure]

The following table describes the components of the response format for a request.

Table 2‒11: Components of the response format

Item

Description

See

Status line

Protocol

Displays the communication protocol used by the API.

--

Protocol version

Displays the version of the communication protocol used by the API.

--

Status code

Execution result of the request is returned as the status code.

  • See Status code in the description for each API.

  • For details about the status code when an error occurs before an API is executed, see the relevant topic in 2.2.17 Status code.

Message

Displays the contents of the status code.

Response header

Content-Type

The response data format specified in the request header is returned.

2.2.13 Response header

Response body

A schema of the data format specified in the request header is returned.

See Response schema in the description for each API.

Legend:

--: Not applicable.