Trigger a source
/mftapp/rest/v1/events
eventSessionid
which is used to track the event status and to get the resulting instance details.Request
- application/json
- Supported parameters for JCA (File, FTP Remote, sFTP Remote) sources:
PatternType
- wildcard or regular expression,IncludePattern
- any wildcard or regular expression filter string,ExcludePattern
- any wildcard or regular expression filter string.PatternType
is a mandatory input parameter if you are passing pattern. - Supported parameters for Oracle Cloud Storage sources:
PayloadKey
,Path
,Delimiter
- Supported parameters for WebCenter Sources:
DocName
,DocId
,RevisionSelectionMethod
,Rendition
,Querytext
,QueryFormat
,SecurityGroup
,DocumentAccount
object
-
properties(optional):
object properties
Title:
properties
Properties passed with the source name. -
sourceName(optional):
string
Name of the source to be triggered.
object
properties
-
entry(optional):
array entry
Title:
entry
Each entry is a key value pair of 'string'.
array
entry
-
[0]:
object items
Title:
items
object
items
-
key(optional):
string
Pattern:
^(/[^/]+)+$
-
value(optional):
string
Pattern:
^(/[^/]+)+$
Response
- application/json
200 Response
object
eventSessionId
-
eventSessionId(optional):
string
The ID of the event created.
500 Response
object
errors
-
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.
Examples
The following cURL example shows how to trigger a file transfer from a specified source by submitting a POST request on the REST resource using cURL.
cURL Command
curl -x post ???u <username>:<password> -H Content-Type:application/json -d @ '{"sourceName": "SFTP Remote Source","properties":{"entry":[{"key":"PatternType","value":"wildcard"},{"key" :"ExcludePattern","value":"*sh"}]}}' http://localhost:port/mftapp/rest/v1/events
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 - 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" }