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: string
ID of the event session,
Query Parameters
-
inDetail(optional): boolean
Return complete details of the resultant instances of an event.
Response
Supported Media Types
- application/json
200 Response
Event details.
Root Schema : eventDetails
Type:
objectTitle:
Show Source
eventDetails-
endpointReference(optional):
string
The source endpoint URL.
-
eventSessionId(optional):
string
Session ID of the event being queried.
-
instances(optional):
array instances
Title:
instancesInformation about the instances. -
sourceName(optional):
string
Name of the source.
-
sourceType(optional):
string
Depicts the source types for which the event was executed (File, FTP, SFTP, etc.).
-
submittedBy(optional):
string
User who submitted the request.
-
totalInstances(optional):
integer
Total number of instances created out of this event.
Nested Schema : instances
Type:
arrayTitle:
instancesInformation about the instances.
Show Source
-
Array of:
object items
Title:
items
Nested Schema : items
Type:
objectTitle:
Show Source
items-
details(optional):
object details
Title:
detailsDetails of the instance. -
fileName(optional):
string
Name of the processed file.
-
status(optional):
object status
Title:
statusString values depicting status of the instance.
Nested Schema : details
Type:
objectTitle:
detailsDetails of the instance.
Show Source
-
bytesReceived(optional):
string
Bytes received.
-
priority(optional):
string
Priority at which file is processed (High, Medium, or Low).
-
receivedTime(optional):
string
Time at which the file was picked up from the source.
-
sourceURL(optional):
string
The source endpoint URL.
-
statusDetail(optional):
string
Consolidated detail about the statuses of the instances related to a particular source.
-
targets(optional):
array targets
Title:
targetsTarget associated with the transfer.
Nested Schema : status
Type:
objectTitle:
statusString values depicting status of the instance.
Show Source
-
status(optional):
string
Final status of the instance (Active, Completed, or Failed).
-
subStatus(optional):
string
Substatus of the instance (Pending, Scheduled, Error, etc.).
Nested Schema : targets
Type:
arrayTitle:
targetsTarget associated with the transfer.
Show Source
-
Array of:
object items
Title:
items
Nested Schema : items
Type:
objectTitle:
Show Source
items-
bytesTransferred(optional):
string
Bytes transferred.
-
completionTime(optional):
string
Time of completion.
-
deliveredFileName(optional):
string
Name of the file delivered.
-
deliveryStatus(optional):
string
Delivery status of the target message (pending, in progress, paused, etc.).
-
status(optional):
string
Overall status of the target message process (Active, Completed, or Failed).
-
targetName(optional):
string
Name of the target.
500 Response
Error information.
Root Schema : error
Type:
objectTitle:
Show Source
error-
errorCode(optional):
string
The error code that Oracle Managed File Transfer returns.
-
errorKey(optional):
string
The error key that Oracle Managed File Transfer returns.
-
errorMessage(optional):
string
A message describing the error that Oracle Managed File Transfer returns.
Examples
The following cURL command shows how to get the details of an event by submitting GET request on the REST resource using cURL. For more information, see Use cURL.
cURL Command
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
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 - 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}."
}