REST API for Oracle Managed File Transfer Cloud Service 12.2.1

Trigger a source

post

/events

Triggers the file transfer from the specified source, submitting the file to MFT for processing. Responds with a unique id called "eventSessionid" which is used to track the event status and to get the resulting instance details.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : eventRequest

Type: object

Properties

properties: Type: object properties

Properties passed with the source name.
sourceName: Type: string

Name of the source to be triggered.

Nested Schema : properties

Type: object

Properties passed with the source name.

Properties

entry: Type: array entry

Nested Schema : entry

Type: array

Items

Type: object entry-items[0]

Nested Schema : entry-items[0]

Type: object

Properties

key: Type: string
value: Type: string

Example application/json


{
    "sourceName":"src1",
    "properties":{
        "entry":[
            {
                "key":"name1",
                "value":"value1"
            },
            {
                "key":"name2",
                "value":"value2"
            }
        ]
    }
}

Response

Supported Media Types

application/json

200 Response

Body

Root Schema : event

Type: object

Properties

eventSessionId: Type: string

The ID of the event created.

Example application/json


{
    "eventSessionId":"799AE14A-9E37-42B9-9789-8F005039953E"
}

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-5423",
    "errorKey":"MFT_WS_EVENT_SERVICE_SOURCE_DONT_EXITS_OR_NOT_DEPLOYED",
    "errorMessage":"Error in processing EventService request. The source Source1 either does not exist or not deployed"
}

Examples

Example of Request Body

The following example shows the contents of the request body in JSON format:

{
  "sourceName": "src1",
  "properties": {
	"entry": [
	  {
		"key": "name1",
		"value": "value1"
	  },
	  {
		"key": "name2",
		"value": "value2"
	  }
			 ]
	}
}

Example of Response Body: 200 Response

The following example shows the contents of the response body for a successful request in JSON format:

{
	"eventSessionId":"799AE14A-9E37-42B9-9789-8F005039953E"
}

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-5423"
	"errorKey":"MFT_WS_EVENT_SERVICE_SOURCE_DONT_EXITS_OR_NOT_DEPLOYED"
	"errorMessage":"Error in processing EventService request. The source {source} either doesn't exist or not deployed"             
  }