REST API for Oracle Managed File Transfer

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: Type: string

Required: true

ID of the event session,

Response

Supported Media Types

application/json

200 Response

Event status.

Body

Root Schema : eventStatus

Type: object

Title: eventStatus

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.

500 Response

Error information.

Body

Root Schema : errors

Type: object

Title: errors

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

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