Jump to

• Request
• Response
• Examples

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 ()

Name of the source to be triggered. Allowed sources are File, FTP Remote, sFTP Remote, WebCenter, and Oracle Storage Cloud Service.

• 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

Root Schema : schema

Type: object

Show Source

• properties(optional): object properties
  Title: properties

  Properties passed with the source name.
• sourceName(optional): string
  Name of the source to be triggered.

{
    "type":"object",
    "properties":{
        "sourceName":{
            "type":"string",
            "description":"Name of the source to be triggered."
        },
        "properties":{
            "title":"properties",
            "type":"object",
            "description":"Properties passed with the source name.",
            "properties":{
                "entry":{
                    "description":"Each entry is a key value pair of 'string'.",
                    "type":"array",
                    "title":"entry",
                    "items":{
                        "title":"items",
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string",
                                "pattern":"^(/[^/]+)+$"
                            },
                            "value":{
                                "type":"string",
                                "pattern":"^(/[^/]+)+$"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Title: properties

Properties passed with the source name.

Show Source

• entry(optional): array entry
  Title: entry

  Each entry is a key value pair of 'string'.

{
    "title":"properties",
    "type":"object",
    "description":"Properties passed with the source name.",
    "properties":{
        "entry":{
            "description":"Each entry is a key value pair of 'string'.",
            "type":"array",
            "title":"entry",
            "items":{
                "title":"items",
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string",
                        "pattern":"^(/[^/]+)+$"
                    },
                    "value":{
                        "type":"string",
                        "pattern":"^(/[^/]+)+$"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Title: entry

Each entry is a key value pair of 'string'.

Show Source

• Array of: object items
  Title: items

{
    "description":"Each entry is a key value pair of 'string'.",
    "type":"array",
    "title":"entry",
    "items":{
        "title":"items",
        "type":"object",
        "properties":{
            "key":{
                "type":"string",
                "pattern":"^(/[^/]+)+$"
            },
            "value":{
                "type":"string",
                "pattern":"^(/[^/]+)+$"
            }
        }
    }
}

Nested Schema : items

Type: object

Title: items

Show Source

• key(optional): string
  Pattern: ^(/[^/]+)+$
• value(optional): string
  Pattern: ^(/[^/]+)+$

{
    "title":"items",
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "pattern":"^(/[^/]+)+$"
        },
        "value":{
            "type":"string",
            "pattern":"^(/[^/]+)+$"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response returned when source is successfully triggered.

Body ()

Root Schema : eventSessionId

Type: object

Title: eventSessionId

Show Source

• eventSessionId(optional): string
  The ID of the event created.

{
    "title":"eventSessionId",
    "type":"object",
    "properties":{
        "eventSessionId":{
            "type":"string",
            "description":"The ID of the event created."
        }
    }
}

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

Back to Top