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.

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

• [0]: 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":"^(/[^/]+)+$"
        }
    }
}

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

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