REST API for Oracle Managed File Transfer Cloud Service 12.2.1

Get the instances summary of an event

get

/events/{eventSessionId}

Gets the event status and instances count for various statuses. Requires submitting an eventSessionId as a path parameter.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Body

Root Schema : eventStatus

Type: object

Properties

activeInstanceCount: Type: integer

The number of active instances.
comments: Type: string

String value describing success or failure reason of the event.
completedInstanceCount: Type: integer

The number of completed instances.
failedInstanceCount: Type: integer

The number of failed instances.
status: Type: string

String value depicting status of the instance.

Example application/json


{
    "activeInstanceCount":0,
    "completedInstanceCount":5,
    "failedInstanceCount":0,
    "status":"DONE"
}

500 Response

Something went wrong

Body

Root Schema : Error information.

Type: object

Title: Error information.

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.

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

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