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.

The request supports optional boolean parameter fileCount. The default value is false. When set to true, the response includes downloadableFileCount, stagedFileCount, and sourceFileCount.

Request

Path Parameters

eventSessionId(required): string

ID of the event session,
fileCount: boolean

When set to true, response includes downLoadableFileCount, stagedFileCount, and sourceFileCount.

Response

Supported Media Types

application/json

200 Response

Event status.

Root Schema : eventStatus

Type: object

Title: eventStatus

Show Source

activeInstanceCount: integer

The number of active instances.
comments: string

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

The number of completed instances.
downloadableFileCount: integer

When fileCount is true, the number of files at the source location that are downloadable candidate files, after the file filters are applied. Applicable for File, FTP, and SFTP source types only.
failedInstanceCount: integer

The number of failed instances.
sourceFileCount: integer

When fileCount is true, the number of files at the source after the file filters are applied. Applicable for File, FTP, and SFTP source types only.
stagedFileCount: integer

When fileCount is true, the number of files successfully staged in Managed File Transfer.
status: 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."
        },
        "downloadableFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files at the source location that are downloadable candidate files, after the file filters are applied. Applicable for File, FTP, and SFTP source types only."
        },
        "failedInstanceCount":{
            "type":"integer",
            "description":"The number of failed instances."
        },
        "stagedFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files successfully staged in Managed File Transfer."
        },
        "sourceFileCount":{
            "type":"integer",
            "description":"When <code>fileCount</code> is <code>true</code>, the number of files at the source after the file filters are applied. Applicable for File, FTP, and SFTP source types only."
        },
        "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.

Root Schema : errors

Type: object

Title: errors

Show Source

errorCode: string

The error code that Oracle Managed File Transfer returns.
errorKey: string

The error key that Oracle Managed File Transfer returns.
errorMessage: 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."
        }
    }
}

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