Get the resultant minimal instances details of event
get
/events/{eventSessionId}/instances
Retrieves minimal details about the instances created by an event. Requires submitting an eventSessionId as a path parameter.
Request
Query Parameters
- inDetail
-
Type:
boolean
Required:true
Returns complete details of the resultant instances of an event.
Response
Supported Media Types
- application/json
- application/json-detailed
200 Response
Body
Root Schema : instanceDetails
Type:
object
- endpointReference
-
Type:
string
The source endpoint URL. - eventSessionId
-
Type:
string
Session ID of the event being queried. - instances
-
Type:
array
instancesInformation 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
Nested Schema : instances-items[0]
Type:
object
- filename
-
Type:
string
Name of the processed file. - status
-
Type:
object
statusString values depicting status of the instance.
Nested Schema : status
Type:
object
String values depicting status of the instance.
- status
-
Type:
string
Final status of the instance (Active, Completed, or Failed). - subStatus
-
Type:
string
Substatus of the instance (Pending, Scheduled, Error, etc.).
Example 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 Response
Something went wrong
Body
Root Schema : Error information.
Type:
object
Title:
Error information.
- 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.
Example 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."
}
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 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 unsuccessful 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}." }