2.2.18 エラー情報
APIのリクエストがエラーになった場合について説明します。APIのリクエストがエラーになった場合,レスポンス情報として,次の表に示すスキーマが返却されます。なお,次の表に示すスキーマ以外のエラー情報については,マニュアルJP1/AO メッセージを参照してください。
エラー情報のスキーマを,次の表に示します。
メンバー名 |
データ型 |
説明 |
---|---|---|
errorSource |
string |
エラーが発生したAPIです。 |
message |
string |
エラーのメッセージ内容です。 |
messageID |
string |
メッセージIDです。リクエストの際にXMLの記載を誤るなどの理由でエラーが発生した場合は,メッセージIDが"generic error"になります。 |
application |
string |
エラーが発生したAPIを保持するアプリケーション情報(Automation)です。 |
messageData |
string |
エラーの詳細情報です。 |
出力例
エラー情報のmessageIDとして,KNAE02102-Eが出力される場合の例を次に示します。
{ "errorSource" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/555", "message" : "The specified resource does not exist or you do not have access. After reviewing the content of the following, please re-run.\n- The presence or absence of resources\n- Access rights to the resource", "messageID" : "KNAE02102-E", "application" : "Automation" }