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

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}."     
}