イベントの結果のインスタンスの詳細の取得
get
/mftapp/rest/v1/events/{eventSessionId}/instances
イベントにより作成されたインスタンスに関する詳細を取得します。パス・パラメータとして、eventSessionIdの送信が必要です。レスポンスに結果のインスタンスの詳細が含まれるようにするには、問合せパラメータinDetail=trueを送信します。レスポンスに最小限の詳細のみが含まれるようにするには、問合せパラメータなしで送信します。
リクエスト
パス・パラメータ
- eventSessionId
-
タイプ:
string
必須:true
イベント・セッションのID。
問合せパラメータ
- inDetail
-
タイプ:
boolean
イベントの結果のインスタンスの詳細を返します。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
イベントの詳細。
本文
ルート・スキーマ: eventDetails
タイプ:
object
タイトル:
eventDetails
- endpointReference
-
タイプ:
string
ソース・エンドポイントURL。 - eventSessionId
-
タイプ:
string
問い合せられたイベントのセッションID。 - instances
-
タイプ:
array
instancesタイトル:instances
インスタンスに関する情報。 - sourceName
-
タイプ:
string
ソース名。 - sourceType
-
タイプ:
string
イベントが実行されたソースのタイプ(ファイル、FTP、SFTPなど)を表します。 - submittedBy
-
タイプ:
string
リクエストを発行したユーザー。 - totalInstances
-
タイプ:
integer
このイベントで作成されたインスタンスの合計数。
ネスト・スキーマ: items
ネスト・スキーマ: details
タイプ:
object
タイトル:
details
インスタンスの詳細。
ネスト・スキーマ: status
タイプ:
object
タイトル:
status
インスタンスのステータスを表す文字列値。
- status
-
タイプ:
string
インスタンスの最終ステータス(「アクティブ」、「完了」または「失敗」)。 - subStatus
-
タイプ:
string
インスタンスのサブステータス(「保留中」、「スケジュール済」、「エラー」など)。
ネスト・スキーマ: items
タイプ:
object
タイプ:
items
- bytesTransferred
-
タイプ:
string
転送済バイト数。 - completionTime
-
タイプ:
string
完了時刻 - deliveredFileName
-
タイプ:
string
配信されたファイルの名前。 - deliveryStatus
-
タイプ:
string
ターゲット・メッセージの配信ステータス(保留中、処理中、一時停止中など)。 - status
-
タイプ:
string
ターゲット・メッセージ処理の全体のステータス(「アクティブ」、「完了」または「失敗」)。 - targetName
-
タイプ:
string
ターゲットの名前。
500レスポンス
エラー情報。
本文
ルート・スキーマ: error
タイプ:
object
タイトル:
error
- errorCode
-
タイプ:
string
Oracle Managed File Transferが返すエラー・コード。 - errorKey
-
タイプ:
string
Oracle Managed File Transferが返すエラー・キー。 - errorMessage
-
タイプ:
string
Oracle Managed File Transferが返すエラーを説明するメッセージ。
例
レスポンス本文の例: 200レスポンス: イベントの最小限のインスタンスの詳細
inDetail=false問合せパラメータが送信されなかった場合の、JSON形式の成功したリクエストに対するレスポンス本文のコンテンツの例を次に示します。
{ "eventSessionId": "ss212020-2139021-122", "totalInstances": 1, "sourceName": "src1", "sourceType": "SFTP", "endpointReference": "srrha1", "submittedBy": "user1", "instances": [ { "filename": "file1", "status": [ { "status": "COMPLETED", "subStatus": "SUCCESSFUL" } ] } ] }
レスポンス本文の例: 200レスポンス: イベントの完全なインスタンスの詳細
inDetail=true問合せパラメータが送信された場合の、JSON形式の成功したリクエストに対するレスポンス本文のコンテンツの例を次に示します。
{ "eventSessionId": "ss212020-2139021-122", "totalInstances": 1, "sourceName": "src1", "sourceType": "SFTP", "endpointReference": "srrha1", "submittedBy": "user1", "instances": [ { "filename": "file1", "status": [ { "status": "COMPLETED", "subStatus": "SUCCESSFUL" } ], "details": [ { "statusDetail": "Successful 1,Errored 0,InPogress 0", "bytesReceived": "28", "receivedTime": "2014-09-30 20:26:36.855", "sourceURL": "http://host:port/mftconsole/faces/report?type=source=0000KZ742Fr1VcHpMs5Eie1KAg5t00000U", "priority": "MEDIUM", "targets": [ { "targetName": "file_tgt2", "status": "COMPLETED", "deliveredFileName": "test1.txt", "bytesTransferred": "28", "completionTime": "2014-09-30 20:26:38.414" } ] } ] } ] }
レスポンス本文の例: 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}." }