Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.2.10 Request header

The request header specifies the data format and language code for the response.

Table 2‒16: Request header

Header

Description

Specifiable value

Default value

Whether specification is required

Host

Specify the following items as host information:

  • Host name or IP address: Host name or IP address of the JP1/AO server

  • Port number: Port number that an API uses to connect to JP1/AO

    When you specify the port number, see 2.2.1 Communication protocol.

Specify this value after checking the user environment.

--

Required

Accept

Specify the desired data format for response data.

  • application/json: JSON format

  • application/xml: XML format

  • multipart/form-data: multipart format#1

  • text/html: HTML format#2

application/json

Required

Accept-Language

Specify the desired language code for response data.

  • ja or ja-JP: Japanese

  • zh or zh-CN: Chinese

  • en or en-US: English

  • Locale for other regions: English

en

Required

Content-Type

Specify the data format for the request body.

  • application/json: JSON format

  • application/xml: XML format

  • application/octet-stream: octet-stream format#3

application/json

Optional

Authorization

Specify authentication information.

For Basic authentication:

user-information

For authentication using the HSSO token:

hsso-token

--

Optional

Legend:

--: Not applicable.

#1

Valid only for the API function Import of a service template.

#2

Valid only for the API function Acquisition of the HTML file necessary for importing a service template.

#3

Valid only for the API function Export of a service template.