結果ドキュメントの取得

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  サーバー API: HTTP、COM/.NET、Java > HTTP インターフェイス > クライアントリクエスト >

結果ドキュメントの取得

このセクション:

 

結果ドキュメント URI
結果ドキュメントの取得
エラードキュメントの URI を含む結果ドキュメント
出力ドキュメントの URI を含む結果ドキュメント
URI を含まない結果ドキュメント
結果ドキュメント内にリストされるエラーと出力ドキュメントへのアクセス

 

結果ドキュメント URI

(例えば、 検証が) ポジティブ、 (ドキュメントが有効) またはネガティブ (ドキュメントが無効)など、ジョブの結果に関わらず、結果ドキュメントは、ジョブが作成される都度作成されます。 両方の場合とも、 201 作成されましたメッセージが返されます。このメッセージは JSON フォーマットで、相対 結果ドキュメントの URIを含みます。JSON フラグメントは以下に類似します:

 

{

"result": "/v1/results/E6C4262D-8ADB-49CB-8693-990DF79EABEB",

"jobid": "E6C4262D-8ADB-49CB-8693-990DF79EABEB"

}

 

result オブジェクトは相対結果ドキュメントの URIを含みます。URI はサーバーアドレスに対して相対的です。例えば、サーバーアドレスが以下の場合 http://localhost:8087/ (初期構成アドレス)。上のリストで指定されている展開された結果ドキュメントの URI は以下のとおりです:

 

http://localhost:8087/v1/results/E6C4262D-8ADB-49CB-8693-990DF79EABEB 

 

メモ:正確なバージョン番号 /vN は、サーバーが返す番号です。 (このドキュメント内に記載されている番号ではない可能性があります)。 サーバーが返す番号は、 現在の HTTP インターフェイスのバージョン番号。 前のバージョン番号は、下位互換性により、サポートされている HTTP インターフェイスの古いバージョンを示します。

 

 

結果ドキュメントの取得

HTTP GET リクエスト内のドキュメントの展開された URI に提出された結果ドキュメントを取得します(上を参照) 下に説明されるジェネリッの型の 1 つにて、結果ドキュメントが返されます。

 

メモ:サーバーキューにジョブが並べられると、サーバーは結果ドキュメントの URI を返します。 クライアントが、ジョブが開始される前に結果をリクエストした場合、 (リクエストがキューの中にある場合) "status": "Dispatched" メッセージが返されます。ジョブが既に開始されており、まだ完了していない場合は、 (例えば大きなジョブの場合) "status": "Running" メッセージが返されます。これらの場合、クライアントは結果ドキュメントの新しいリクエストを行うまで時間を置く必要があります。

 

メモ:下のサンプルドキュメントは、すべて制限された クライアントアクセスと仮定されます。 ですから、 エラードキュメント、 メッセージドキュメント、および出力ドキュメントは、サーバー上の関連するジョブディレクトリに保存されます。 結果ドキュメント内のこれらのドキュメントの URI はですからすべて相対 URI です。 すべては、ファイル URI ではありません(無制限のクライアントアクセスの場合生成されるの種類ではありません )。これらの URI の詳細に関しては、 エラー/メッセージ/出力ドキュメントの取得のセクションを参照してください。 .

 

 

 

エラードキュメントの URI を含む結果ドキュメント

リクエストされたジョブがの失敗した状態で完了した場合、ジョブはネガティブな結果を返したこになります。  例えば、 検証ジョブ が無効なドキュメントの結果を返した場合。ジョブ実行中に発生したエラーは、 3 つのファイルフォーマット内で作成されたエラーログに保管されます: (i) テキスト、 (ii) ロング-XML (詳細つきの エラーログ)、 および (iii) ショート-XML (短い詳細付きの エラーログ)。  下の JSON リストを参照してください。

 

 

{

"jobid": "6B4EE31B-FAC9-4834-B50A-582FABF47B58",

"state": "Failed",

"error":

{

  "text": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/error.txt",

  "longxml": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/long.xml",

  "shortxml": "/v1/results/6B4EE31B-FAC9-4834-B50A-582FABF47B58/error/short.xml"

},

"jobs":

[

  {

    "file": "file:///c:/Test/ExpReport.xml",

    "jobid": "20008201-219F-4790-BB59-C091C276FED2",

    "output":

    {

    },

    "state": "Failed",

    "error":

    {

      "text": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/error.txt",

      "longxml": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/long.xml",

      "shortxml": "/v1/results/20008201-219F-4790-BB59-C091C276FED2/error/short.xml"

    }

  }

]

}

 

 

以下の点に注意してください:

 

ジョブにはサブジョブがあります。
サブレベルのエラーは、トップレベルのジョブに反映されます。トップレベルのジョブの状態は、すべてのサブジョブの状態が OK であり始めて OK になります。
各ジョブまたはサブジョブにはそれぞれのエラーログがあります。
エラーログ は、警告ログを含みます。 ジョブが OK の状態で完了したにもかかわらず、結果ドキュメントは、エラーファイルの URI を含む場合があります。
エラーファイルの URI はサーバーアドレスに対して相対的です (上を参照) 。

 

出力ドキュメントの URI を含む結果ドキュメント

リクエストされたジョブが OK の状態で完了すると、ジョブはポジティブな結果を返します。 例えば、検証ジョブがドキュメント有効な結果を返した場合。 ジョブが出力ドキュメントを作成した場合。—例えば、 XSLT 変換の結果—出力ドキュメントの URI が返されます。 下の JSON リストを参照してください。

 

 

{

"jobid": "5E47A3E9-D229-42F9-83B4-CC11F8366466",

"state": "OK",

"error":

{

},

"jobs":

[

  {

    "file": "file:///c:/Test/SimpleExample.xml",

    "jobid": "D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8",

    "output":

    {

      "xslt-output-file":

      [

        "/v1/results/D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8/output/1"

      ]

    },

    "state": "OK",

    "output-mapping":

    {

"/v1/results/D34B5684-C6FF-4A7A-BF35-EBB9A8A8C2C8/output/1": "file:///c:/temp/test.html"

    },

    "error":

    {

    }

  }

]

}

 

 

以下の点に注意してください:

 

出力ファイルがジョブの output フォルダー内に作成されます。 相対 URI を使用してファイルにアクセスします。
出力ファイルの URI は サーバーアドレス に相対します。(上を参照)。
output-mapping アイテムは、ジョブリクエスト内のクライアントにより指定されているファイルロケーション上のジョブディレクトリ内の出力ドキュメントにマップします。ジョブリクエスト内のクライアントにより指定された出力ドキュメントのみに マッピングがあることに注意してください。(エラーファイルなどの) サーバーに生成されたジョブに関連したファイルにはマッピングがありません。
または、 URL "/v1/results/JOBID/output/zip" を使用して、ZIP アーカイブとして、特定のジョブのために生成されたすべての結果ドキュメントを取得することができます。この機能は、制約されていない filesystem モードでは使用することができません。ZIP アーカイブは、 output-mapping オブジェクトを使用し実際の名前にマップされ戻される壊れたファイル名を含みます。

 

URI を含まない結果ドキュメント

リクエストされたジョブが OK の状態で完了すると、 ジョブはポジティブな結果を返します。 例えば、検証ジョブがドキュメント有効な結果を返した場合。 検証または整形式のチェックなどジョブの一部が出力ドキュメントを作成しない場合。 この型のジョブが OK の状態で完了すると、 結果ドキュメントは、出力ドキュメントの URI またはエラーログの URI を持ちません。下の JSON リストを参照してください。

 

 

{

"jobid": "3FC8B90E-A2E5-427B-B9E9-27CB7BB6B405",

"state": "OK",

"error":

{

},

"jobs":

[

  {

    "file": "file:///c:/Test/SimpleExample.xml",

    "jobid": "532F14A9-F9F8-4FED-BCDA-16A17A848FEA",

    "output":

    {

    },

    "state": "OK",

    "error":

    {

    }

  }

]

}

 

 

以下の点に注意してください:

 

上のリストのサブジョブの出力とエラーコンポーネントの双方は空白です。
ジョブは、 OK の状態で完了することができますが、エラーファイル内でエラーとログされる警告または他のメッセージを含んでい場合があります。この様な場合、 ジョブが OK の状態で完了したにもかかわらず、結果ドキュメントは、エラーファイルの URI を含む場合があります。

 

結果ドキュメント内にリストされるエラーと出力ドキュメントへのアクセス

エラーと出力ドキュメントは、 HTTP GET リクエストを使用してアクセスすることができます。この点については次のセクションエラー/出力ドキュメントの取得で説明されています。

 


(C) 2019 Altova GmbH