Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager コマンド・定義ファイル・APIリファレンス


5.2.6 エラー発生時のレスポンスメッセージ

ステータスコードが「200」以外の場合は,レスポンスのメッセージボディーに次の例外オブジェクトを設定します。

{
"timestamp":1539923958358,
"status":403,
"error":"Forbidden",
"exception":"jp.co.hitachi_solutions.it_service_cooperation_framework.security.ImDdBadCredentialsException",
"message":"パラメーター不正によりログイン処理に失敗しました。,
"path":"/im/api/v1/login",
"messageId":"KAJY52001-E",
"returnCode":3
}
表5‒8 エラー発生時のレスポンス形式の構成内容

項目

説明

timestamp

1970年1月1日0:00からの経過を,ミリ秒単位(UTC形式)で設定します。

status

レスポンス形式のstatusCodeです。

exception

発生した例外オブジェクトのクラスです。

message

発生した例外オブジェクトが保持するメッセージです。

Throwable#getMessage()で得られる文字列)

path

発行したREST APIのURIのpath以降です。

messageId

JP1のメッセージIDです。

returnCode

REST APIの戻り値です。

extensions

レスポンスの拡張情報です。