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, binding type, etc. The response contains the list of sources with URLs.

Request

Query Parameters

application: Type: string

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

Binding type of source you want to discover
onlyEventEnabled: Type: boolean

Discover only event enabled sources
searchFilter: Type: string

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

Response

Supported Media Types

application/json

200 Response

Describes active sources.

Body

Root Schema : activeSources

Type: object

Title: activeSources

Properties

sources: Type: array sources

Title: sources

Sources discovered

Nested Schema : sources

Type: array

Title: sources

Sources discovered

Items

Type: object items

Title: items

Nested Schema : items

Type: object

Title: items

Properties

bindingType: Type: string

Binding type of the source.
eventInvokeUrl: Type: string

URL at which to invoke the event.
name: Type: string

Name of the source.
url: Type: string

URL of the source.

500 Response

Error information.

Body

Root Schema : errors

Type: object

Title: errors

Properties

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 Response Body: 200 Response

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