ステータスサービスは、指定されたステータスのステータスを取得するAPIを提供します。クライアントアプリケーションは、Token APIを使用して、指定されたステータスのステータスを取得するためのHTTP要求をサービスアプリケーションに送信します。

ステータスサービスの要求スキーマ

指定されたトークンのステータスを取得するには、GETメソッドを使用する必要があります。トークン情報は、次のような要求URLで指定します。

GET：http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}/status

URLパラメータ

パラメータ	説明
Data Source	トークン情報を取得するデータ ソースを指定します。
Token	分析インスタンスを指定するために使用されます。 トークンの値を3番目のサービスから取得できます。

レスポンスメッセージ

HTTPステータスコード	原因
200	ステータスを指定するIStatusオブジェクトが返されます。 ステータスが「Completed」の場合、クエリが正常に実行され、出力用ためにデータが準備されていることを意味します。 ステータスAPIが正常に返されると、結果データサービスを使用してデータを取得できます。 ステータスが「実行中」の場合は、ステータスが完了、クリアまたは例外に変更されるまで、このリクエストを繰り返し送信できます。 ステータスが「例外」の場合、実行中に何らかのエラーが発生したことを意味します。 たとえば、この要求で指定されたトークンが存在しない場合、例外が応答として返されます。
404	無効な{datasource}や{token}です。

分析の要求スキーマ

分析サービスは、指定されたトークンに従って分析データを計算するためのAPIを提供します。クライアントアプリケーションは、Analysis APIを使用するためにサービスアプリケーションにHTTP要求を送信します。

指定されたトークンスに従って分析データを取得するには、GETメソッドを使用する必要があります。トークン情報は、次のような要求URLで指定します。

GET：http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}

HTTPステータスコード	原因
200	分析結果情報が指定されるIAnalysisオブジェクトが返されます。
404	無効な{datasource}や{token}です。

結果データサービスの要求スキーマ

結果データサービスは、指定されたステータスに基づいて結果データを取得するAPIを提供します。クライアントアプリケーションは、Result Data APIを使用して、指定されたステータスに基づいて結果データを取得するためのHTTP要求をサービスアプリケーションに送信します。

指定されたステータスに基づいて結果データを取得するには、GETメソッドを使用する必要があります。ステータス情報は、次のような要求URLで指定します。

GET: http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}/result

レスポンスメッセージ

HTTPステータスコード	原因
200	結果データを指定するために配列オブジェクトが返されます。 このサービスを呼び出して準備されたデータを取得した後、トークンが削除されます。 このトークンを他のリクエストでは使用できません。 それを使用した場合、例外が返されます。
404	無効な{datasource}や{token}です。

ステータスクリアサービスの要求スキーマ

ステータスクリアサービスは、不要になったステータスをクリアするAPIを提供します。クライアントアプリケーションは、Clear Token APIを使用して不要になったステータスをクリアするためのHTTP要求をサービスアプリケーションに送信します。

指定されたステータスに基づいて結果データを取得するには、DELETEメソッドを使用する必要があります。ステータス情報は、次のような要求URLで指定します。

DELETE: http://<host>[:port]/api/dataengine/{datasourcekey}/analyses/{token}

レスポンスメッセージ

HTTPステータスコード	原因
204	応答の内容はありません。
404	無効な{datasource}や{token}です。