Trigger a source
post
/mftapp/rest/v1/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
Name of the source to be triggered.
Root Schema : /paths/~1events/post/parameters/0/schema
Type:
object
- properties
-
Type:
object
propertiesTitle:properties
Properties passed with the source name. - sourceName
-
Type:
string
Name of the source to be triggered.
Nested Schema : properties
Type:
object
Title:
properties
Properties passed with the source name.
- entry
-
Type:
array
entryTitle:entry
Each entry is a key value pair of 'string'.
Nested Schema : entry
Nested Schema : items
Type:
object
Title:
items
- key
-
Type:
string
Pattern:^(/[^/]+)+$
- value
-
Type:
string
Pattern:^(/[^/]+)+$
Response
Supported Media Types
- application/json
200 Response
Response returned when source is successfully triggered.
Body
Root Schema : eventSessionId
Type:
object
Title:
eventSessionId
- eventSessionId
-
Type:
string
The ID of the event created.
500 Response
Error information.
Body
Root Schema : errors
Type:
object
Title:
errors
- 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 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 successful 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" }