イベントの結果インスタンスの詳細の取得
get
/mftapp/rest/v1/events/{eventSessionId}/instances
イベントによって作成されたインスタンスについて詳細を取得します。パス・パラメータとして
eventSessionId
を送信する必要があります。レスポンスに結果インスタンスの完全な詳細を含めるには、問合せパラメータをinDetail=true
で発行します。レスポンスに最小限の詳細を含めるには、問合せパラメータなしで発行します。リクエスト
パス・パラメータ
- eventSessionId: string
イベント・セッションのID
問合せのパラメータ
- inDetail(optional): boolean
イベントの結果インスタンスの完全な詳細を返します。
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
イベント詳細。
ルート・スキーマ: eventDetails
型:
object
タイトル:
ソースを表示
eventDetails
- endpointReference(optional): string
ソース・エンドポイントURL。
- eventSessionId(optional): string
問合せ対象イベントのセッションID。
- instances(optional): array instances
タイトル:
instances
インスタンスに関する情報。 - sourceName(optional): string
ソースの名前。
- sourceType(optional): string
イベントが実行された対象のソース・タイプ(ファイル、FTP、SFTPなど)を示します。
- submittedBy(optional): string
リクエストを送信したユーザー。
- totalInstances(optional): integer
このイベントから作成されたインスタンスの合計数。
ネストされたスキーマ: instances
型:
array
タイトル:
instances
インスタンスに関する情報。
ソースを表示
- Array of: object アイテム
タイトル:
items
ネストされたスキーマ: items
型:
object
タイトル:
ソースを表示
items
- details(optional): object details
タイトル:
details
インスタンスの詳細。 - fileName(optional): string
処理されたファイルの名前。
- status(optional): object status
タイトル:
status
インスタンスのステータスを示す文字列値。
ネストされたスキーマ: details
型:
object
タイトル:
details
インスタンスの詳細。
ソースを表示
- bytesReceived(optional): string
受信したバイト数。
- priority(optional): string
ファイルが処理される優先度(高、中または低)。
- receivedTime(optional): string
ファイルがソースから取得された時間。
- sourceURL(optional): string
ソース・エンドポイントURL。
- statusDetail(optional): string
特定のソースに関連するインスタンスのステータスに関する統合された詳細。
- targets(optional): array targets
タイトル:
targets
転送に関連付けられているターゲット。
ネストされたスキーマ: status
型:
object
タイトル:
status
インスタンスのステータスを示す文字列値。
ソースを表示
- status(optional): string
インスタンスの最終ステータス(「アクティブ」、「完了」または「失敗」)。
- subStatus(optional): string
インスタンスのサブステータス(「保留中」、「スケジュール済」、「エラー」など)。
ネストされたスキーマ : targets
型:
array
タイトル:
targets
転送に関連付けられているターゲット。
ソースを表示
- Array of: object アイテム
タイトル:
items
ネストされたスキーマ: items
型:
object
タイトル:
ソースを表示
items
- bytesTransferred(optional): string
転送されたバイト数。
- completionTime(optional): string
完了した時間。
- deliveredFileName(optional): string
配信されたファイルの名前。
- deliveryStatus(optional): string
ターゲット・メッセージの配信ステータス(pending、in progress、pausedなど)。
- status(optional): string
ターゲット・メッセージ処理の全体ステータス(Active、Completed、Failed)。
- targetName(optional): string
ターゲットの名前。
500レスポンス
エラー情報。
ルート・スキーマ : error
型:
object
タイトル:
ソースを表示
error
- errorCode(optional): string
Oracle Managed File Transferから返されるエラー・コード。
- errorKey(optional): string
Oracle Managed File Transferから返されるエラー・キー。
- errorMessage(optional): string
Oracle Managed File Transferから返されるエラーを説明するメッセージ。
例
次のcURLコマンドは、cURLを使用してRESTリソースにGETリクエストを発行して、イベントの詳細を取得する方法を示しています。詳細は、「cURLの使用」を参照してください。
cURLコマンド
curl -I -X GET -u <username>:<password> -H "Content-Type: application/json" http://<host>:<port>/mftapp/rest/v1/mftapp/rest/v1/events/ss212020-2139021-122/instances
レスポンス本文の例: 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}." }