Get the instances summary of an event
get
/mftapp/rest/v1/events/{eventSessionId}
Gets the event status and instances count for various statuses. Requires submitting an eventSessionId as a path parameter.
Request
Path Parameters
-
eventSessionId: string
ID of the event session,
Response
Supported Media Types
- application/json
200 Response
Event status.
Root Schema : eventStatus
Type:
object
Title:
Show Source
eventStatus
-
activeInstanceCount(optional):
integer
The number of active instances.
-
comments(optional):
string
String value describing success or failure reason of the event.
-
completedInstanceCount(optional):
integer
The number of completed instances.
-
failedInstanceCount(optional):
integer
The number of failed instances.
-
status(optional):
string
String value depicting status of the instance.
500 Response
Error information.
Root Schema : errors
Type:
object
Title:
Show Source
errors
-
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
Example of Response Body: 200 Response
The following example shows the contents of the response body for a successful request in JSON format:
{ "activeInstanceCount":"0" "completedInstanceCount":"5" "failedInstanceCount":"0" "status":"DONE" }
Example - 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}." }