REST API for Oracle Managed File Transfer

Get the details of the resultant instances of an event

get

/mftapp/rest/v1/events/{eventSessionId}/instances

Retrieves details about the instances created by an event. Requires submitting an eventSessionId as a path parameter. Submit with query parameter inDetail=true for response to contain complete details of the resultant instances; submit without query parameter for response to contain minimal details.

Request

Path Parameters

eventSessionId: Type: string

Required: true

ID of the event session,

Query Parameters

inDetail: Type: boolean

Return complete details of the resultant instances of an event.

Response

Supported Media Types

application/json

200 Response

Event details.

Body

Root Schema : eventDetails

Type: object

Title: eventDetails

Properties

endpointReference: Type: string

The source endpoint URL.
eventSessionId: Type: string

Session ID of the event being queried.
instances: Type: array instances

Title: instances

Information about the instances.
sourceName: Type: string

Name of the source.
sourceType: Type: string

Depicts the source types for which the event was executed (File, FTP, SFTP, etc.).
submittedBy: Type: string

User who submitted the request.
totalInstances: Type: integer

Total number of instances created out of this event.

Nested Schema : instances

Type: array

Title: instances

Information about the instances.

Items

Type: object items

Title: items

Nested Schema : items

Type: object

Title: items

Properties

details: Type: object details

Title: details

Details of the instance.
fileName: Type: string

Name of the processed file.
status: Type: object status

Title: status

String values depicting status of the instance.

Nested Schema : details

Type: object

Title: details

Details of the instance.

Properties

bytesReceived: Type: string

Bytes received.
priority: Type: string

Priority at which file is processed (High, Medium, or Low).
receivedTime: Type: string

Time at which the file was picked up from the source.
sourceURL: Type: string

The source endpoint URL.
statusDetail: Type: string

Consolidated detail about the statuses of the instances related to a particular source.
targets: Type: array targets

Title: targets

Target associated with the transfer.

Nested Schema : status

Type: object

Title: status

String values depicting status of the instance.

Properties

status: Type: string

Final status of the instance (Active, Completed, or Failed).
subStatus: Type: string

Substatus of the instance (Pending, Scheduled, Error, etc.).

Nested Schema : targets

Type: array

Title: targets

Target associated with the transfer.

Items

Type: object items

Title: items

Nested Schema : items

Type: object

Title: items

Properties

bytesTransferred: Type: string

Bytes transferred.
completionTime: Type: string

Time of completion.
deliveredFileName: Type: string

Name of the file delivered.
deliveryStatus: Type: string

Delivery status of the target message (pending, in progress, paused, etc.).
status: Type: string

Overall status of the target message process (Active, Completed, or Failed).
targetName: Type: string

Name of the target.

500 Response

Error information.

Body

Root Schema : error

Type: object

Title: error

Properties

errorCode: Type: string

The error code that Oracle Managed File Transfer returns.
errorKey: Type: string

The error key that Oracle Managed File Transfer returns.
errorMessage: Type: string

A message describing the error that Oracle Managed File Transfer returns.

Examples

Example of Response Body: 200 Response: Minimal Instance Details of an Event

The following example shows the contents of the response body for a successful request in JSON format when the inDetail=false query parameter is not submitted:

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

Example of Response Body: 200 Response: Complete Instance Details of an Event

The following example shows the contents of the response body for a successful request in JSON format when the inDetail=true query parameter is submitted:

{
	  "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"
						  }
					  ]
				  }
			  ]
		  }
	  ]
}

Example of Response Body: 500 Response

The following example shows the contents of the response body for an successful request in JSON format:

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