イベントのインスタンス・サマリーの取得

get

/mftapp/rest/v1/events/{eventSessionId}

イベント・ステータスと様々なステータスのインスタンス数を取得します。パス・パラメータとしてeventSessionIdを送信する必要があります。

• リクエスト
• レスポンス
• 例

リクエスト

パス・パラメータ

eventSessionId

型: string

必須: true

イベント・セッションのID

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

イベント・ステータス。

本文

ルート・スキーマ: eventStatus

型: object

タイトル: eventStatus

プロパティ

activeInstanceCount

型: integer

アクティブなインスタンスの数。

comments

型: string

イベントの成功または失敗の理由を説明する文字列値。

completedInstanceCount

型: integer

完了したインスタンスの数。

failedInstanceCount

型: integer

失敗したインスタンスの数。

status

型: string

インスタンスのステータスを示す文字列値。

500レスポンス

エラー情報。

本文

ルート・スキーマ : errors

型: object

タイトル: errors

プロパティ

errorCode

型: string

Oracle Managed File Transferから返されるエラー・コード。

errorKey

型: string

Oracle Managed File Transferから返されるエラー・キー。

errorMessage

型: string

Oracle Managed File Transferから返されるエラーを説明するメッセージ。

例

レスポンス本文の例: 200レスポンス

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(JSON形式)。

{
  "activeInstanceCount":"0"
   "completedInstanceCount":"5"
   "failedInstanceCount":"0"
   "status":"DONE"                  
}

レスポンス本文の例: 500レスポンス

次の例では、失敗したリクエストのレスポンス本文のコンテンツを示しています(JSON形式)。

{
	"errorCode":"MFT-5436"
	"errorKey":"MFT_WS_EVENT_SERVICE_NO_EVENT_FOUND"
	"errorMessage":"Error in processing EventService request. No Event found with provided Event Session Id {id}."     
}