イベントの結果インスタンスの詳細の取得
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
-
型:
arrayinstancesタイトル: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ターゲット・メッセージの配信ステータス(pending、in progress、pausedなど)。 - status
-
型:
stringターゲット・メッセージ処理の全体ステータス(Active、Completed、Failed)。 - targetName
-
型:
stringターゲットの名前。
500レスポンス
エラー情報。
本文
ルート・スキーマ : error
型:
objectタイトル:
error- errorCode
-
型:
stringOracle Managed File Transferから返されるエラー・コード。 - errorKey
-
型:
stringOracle Managed File Transferから返されるエラー・キー。 - errorMessage
-
型:
stringOracle 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}."
}