Jump to

• Request
• Response
• Examples

Get the instances summary of an event

get

/mftapp/rest/v1/events/{eventSessionId}

Get 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,

Back to Top

Response

Supported Media Types

• application/json

200 Response

Event status.

Body ()

Root Schema : eventStatus

Type: object

Title: eventStatus

Show Source

• 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.

{
    "title":"eventStatus",
    "type":"object",
    "properties":{
        "activeInstanceCount":{
            "type":"integer",
            "description":"The number of active instances."
        },
        "completedInstanceCount":{
            "type":"integer",
            "description":"The number of completed instances."
        },
        "failedInstanceCount":{
            "type":"integer",
            "description":"The number of failed instances."
        },
        "status":{
            "type":"string",
            "description":"String value depicting status of the instance."
        },
        "comments":{
            "type":"string",
            "description":"String value describing success or failure reason of the event."
        }
    }
}

500 Response

Error information.

Body ()

Root Schema : errors

Type: object

Title: errors

Show Source

• 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.

{
    "title":"errors",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code that Oracle Managed File Transfer returns."
        },
        "errorKey":{
            "type":"string",
            "description":"The error key that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"A message describing the error that Oracle Managed File Transfer returns."
        }
    }
}

Back to Top

Examples

The following cURL example shows how to get event summary by submitting a GET request on the REST resource using cURL.

curl -i -X GET -u <username>:<password> -H "Content-Type: application/json"  http://<host>:<port>/mftapp/rest/v1/events/77990703-A512-4469-924C-891170EC0EAA 

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

Back to Top