Oracle Managed File Transfer Cloud Service REST API 12.2.1.2

機械翻訳について

イベント結果の最小インスタンス詳細の取得

get

/events/{eventSessionId}/instances

イベントによって作成されたインスタンスについて最小限の詳細を取得します。パス・パラメータとしてeventSessionIdを送信する必要があります。

リクエスト

問合せのパラメータ

inDetail: 型: boolean

イベントの結果インスタンスの完全な詳細を返します。

レスポンス

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

application/json
application/json-detailed

200レスポンス

本文

ルート・スキーマ: instanceDetails

型: object

プロパティ

endpointReference: 型: string

ソース・エンドポイントURL。
eventSessionId: 型: string

問合せ対象イベントのセッションID。
instances: 型: array instances

インスタンスに関する情報。
sourceName: 型: string

ソースの名前。
sourceType: 型: string

イベントが実行された対象のソース・タイプ(ファイル、FTP、SFTPなど)を示します。
submittedBy: 型: string

リクエストを送信したユーザー。
totalInstances: 型: integer

このイベントから作成されたインスタンスの合計数。

ネストされたスキーマ: instances

型: array

インスタンスに関する情報。

項目

型: object instances-items[0]

ネストされたスキーマ: instances-items[0]

型: object

プロパティ

filename: 型: string

処理されたファイルの名前。
status: 型: object status

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

ネストされたスキーマ: status

型: object

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

プロパティ

status: 型: string

インスタンスの最終ステータス(「アクティブ」、「完了」または「失敗」)。
subStatus: 型: string

インスタンスのサブステータス(「保留中」、「スケジュール済」、「エラー」など)。

application/jsonの例


{
    "eventSessionId":"ss212020-2139021-122",
    "totalInstances":1,
    "sourceName":"src1",
    "sourceType":"SFTP",
    "endpointReference":"srrha1",
    "submittedBy":"user1",
    "instances":[
        {
            "filename":"file1",
            "status":{
                "status":"COMPLETED",
                "subStatus":"SUCCESSFUL"
            }
        }
    ]
}

500レスポンス

問題が発生

本文

ルート・スキーマ: Error information.

型: object

タイトル: Error information.

プロパティ

errorCode: 型: string

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

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

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

application/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 799AE14A-9E37-42B9-9789-8F005039953."
}

例

レスポンス本文の例: 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}."     
}