REST API for Oracle Managed File Transfer

Get available active sources

get

/mftapp/rest/v1/sources

Gets the list of sources active in MFT based on the criteria like application type or binding type. The response contains the list of sources with URLs. If you are invoking this API without any query parameters, you will get only sources with bindingType as Webservices such as SOA, SOAP, ODI, and OSB. To get other sources, pass bindingType and/or application parameters to the query. If the application and bindingType parameters are not provided then searchFilter and onlyEventEnabled filters are ignored. Supported Application Types include B2B, Healthcare, OSB, SOA, and, ODI. Supported Binding Types include Embedded-FTP, Embedded-SSH-FTP, File, FTP, SSH-FTP, WS, B2B, Healthcare, OCSS, and RIDC.

Request

Query Parameters

application: string

Type of the application binding you want to discover
bindingType: string

Binding type of source you want to discover
onlyEventEnabled: boolean

Discover only event enabled sources
searchFilter: string

Full/partial name of source(s) to be discovered

Response

Supported Media Types

application/json

200 Response

Describes active sources.

Root Schema : activeSources

Type: object

Title: activeSources

Show Source

sources: array sources

Title: sources

Sources discovered

{
    "title":"activeSources",
    "type":"object",
    "properties":{
        "sources":{
            "title":"sources",
            "type":"array",
            "description":"Sources discovered",
            "items":{
                "title":"items",
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Name of the source."
                    },
                    "url":{
                        "type":"string",
                        "description":"URL of the source."
                    },
                    "bindingType":{
                        "type":"string",
                        "description":"Binding type of the source."
                    },
                    "eventInvokeUrl":{
                        "type":"string",
                        "description":"URL at which to invoke the event."
                    }
                }
            }
        }
    }
}

Nested Schema : sources

Type: array

Title: sources

Sources discovered

Show Source

Array of: object items

Title: items

{
    "title":"sources",
    "type":"array",
    "description":"Sources discovered",
    "items":{
        "title":"items",
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Name of the source."
            },
            "url":{
                "type":"string",
                "description":"URL of the source."
            },
            "bindingType":{
                "type":"string",
                "description":"Binding type of the source."
            },
            "eventInvokeUrl":{
                "type":"string",
                "description":"URL at which to invoke the event."
            }
        }
    }
}

Nested Schema : items

Type: object

Title: items

Show Source

bindingType: string

Binding type of the source.
eventInvokeUrl: string

URL at which to invoke the event.
name: string

Name of the source.
url: string

URL of the source.

{
    "title":"items",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the source."
        },
        "url":{
            "type":"string",
            "description":"URL of the source."
        },
        "bindingType":{
            "type":"string",
            "description":"Binding type of the source."
        },
        "eventInvokeUrl":{
            "type":"string",
            "description":"URL at which to invoke the event."
        }
    }
}

500 Response

Error information.

Root Schema : errors

Type: object

Title: errors

Show Source

errorCode: string

The error code that Oracle Managed File Transfer returns.
errorKey: string

The error key that Oracle Managed File Transfer returns.
errorMessage: 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 Response Body: 200 Response

The following cURL commands shows how to get the source details based on the various query parameters by submitting GET request on the REST resource:

To list all the files sources:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" 'http://<host>:<port>/mftapp/rest/v1/sources?bindingType=file'

To list all the file sources with name containing string abc:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?bindingType=File&&searchFilter=abc

To list all Event-enabled FTP sources:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?bindingType=FTP&onlyEventEnabled=true

To list all SOA sources:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?application=soa

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

{
	"sources": [
	  {
		"name": "src1",
		"url": "/scratch/demo",
		"bindingType": "File",
		"eventInvokeUrl": "/mftapp/rest/v1/events"
	  },
	  {
		"name": "src2",
		"url": "/scratch/username",
		"bindingType": "File",
		"eventInvokeUrl": "/mftapp/rest/v1/events"
	  }
	]
}

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-5403"
  "errorKey":"MFT_WS_DISCOVERY_COULD_NOT_QUERY_MFT_SOURCES"
  "errorMessage":"Discovery service is unable to query MFT Sources for the given application {application} and search Filter {search filter}."
}