7.2.3. ジョブ (API 要求)
ナレッジストア REST API の POST
と DELETE
要求はすべて、返される要求詳細のほかに、各要求に関連付けられたジョブ ID を返します。ジョブ ID を使用すると、要求ステータスを確認したり、送信された要求を削除することができます。
ナレッジストア REST API 要求もしくは ジョブ には、以下のステータスがあります。
ステータス | 説明 |
---|---|
| ジョブが受け入れられ、処理中である。 |
| 要求に無効なコンテンツが含まれ、受け入れられなかった。 |
| 要求されたリソース (パス) が存在しない。 |
| リソースがすでに存在する。 |
| Decision Server でエラーが発生した。 |
| 要求が正常に完了した。 |
| 要求が失敗した。 |
| 要求が承認された。 |
| 要求が拒否された。 |
| 以下のいずれかの理由で要求のジョブ ID が見つからなかった。
|
ナレッジストア REST API は、送信済み API 要求の取得または削除用の以下のエンドポイントをサポートします。ナレッジストア REST API のベース URL は http://SERVER:PORT/decision-central/rest/
です。ユーザーロール rest-all
では、すべての要求で HTTP の Basic 認証またはトークンベースの認証が必要です。
- [GET] /jobs/{jobId}
指定されたジョブのステータスを返します (以前に送信された API 要求)。
表7.14 要求パラメーター Name 説明 タイプ 要件 jobId
取得するジョブの ID (例:
1541010216919-1
)文字列
必須
サーバーの応答例 (JSON)
{ "status": "SUCCESS", "jobId": "1541010216919-1", "result": null, "lastModified": 1541010218352, "detailedResult": [ "level:INFO, path:null, text:Build of module 'Mortgage_Process' (requested by system) completed.\n Build: SUCCESSFUL" ] }
- [DELETE] /jobs/{jobId}
指定したジョブ (以前に送信された API 要求) を削除します。ジョブがまだ処理されていない場合、この要求はジョブをジョブキューから削除します。実行中のジョブがキャンセルされたり停止されたりすることはありません。
表7.15 要求パラメーター Name 説明 タイプ 要件 jobId
削除するジョブの ID (例:
1541010216919-1
)文字列
必須
サーバーの応答例 (JSON)
{ "status": "GONE", "jobId": "1541010216919-1", "result": null, "lastModified": 1541132054916, "detailedResult": [ "level:INFO, path:null, text:Build of module 'Mortgage_Process' (requested by system) completed.\n Build: SUCCESSFUL" ] }