Hitachi

JP1 Version 11 JP1/Operations Analytics REST APIリファレンス


1.2.5 レスポンス形式

リクエストに対するレスポンス形式は,ステータスライン,レスポンスヘッダー,レスポンスボディーで構成されます。

〈この項の構成〉

(1) ステータスライン

ステータスラインを構成する要素を次の表に示します。

項目

説明

参照先

プロトコル

APIが利用する通信プロトコルが表示されます。

プロトコルのバージョン

APIが利用する通信プロトコルのバージョンが表示されます。

ステータスコード

リクエストの実行結果がステータスコードとして返却されます。

各APIの「ステータスコード」を参照してください。APIを実行する前にエラーとなった場合のステータスコードは「1.2.6 ステータスコード」を参照してください。

メッセージ

ステータスコードの内容が表示されます。

(凡例)−:該当しません。

(2) レスポンスヘッダー

JP1/OAで制御可能なヘッダーを次の表に示します。

表1‒3 JP1/OAで制御可能なヘッダー

ヘッダー

説明

Cache-Control

GETメソッドを指定したAPIのレスポンス情報をキャッシュ制御します。

Content-Type

レスポンスデータのデータ形式です。

Language

レスポンスデータの言語コードです。

WWW-Authenticate

認証されたHSSOトークンを出力します。

Warning

APIは成功したがサーバの状態に問題がある場合に,その情報を英語で説明する(http標準仕様で英語のみ許可される)

(3) レスポンスボディー

APIが呼び出された際に返却されるレスポンスデータが含まれます。レスポンスデータのデータ形式は,リクエストヘッダーに指定されたデータ形式に従います。レスポンスデータの形式はAPIごとに異なります。各APIの説明を参照してください。