REST API for Oracle Managed File Transfer

Export MFT artifacts and config plan file

get

/mftapp/rest/v1/artifacts

Exports MFT artifacts in zip format and config plan file in XML format.

Request

Query Parameters

domainName: string

Domain Name
sourceName: string

Source name to be exported
targetName: string

Target of export
transferName: string

Name of transfer

Response

Supported Media Types

application/json

200 Response

Export artifact was completed.

Headers

location: string

Relative URL of the export properties.

500 Response

Root Schema : Error information.

Type: object

Title: Error information.

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.

{
    "type":"object",
    "title":"Error information.",
    "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."
        }
    }
}

Example Response (application/json)

{
    "errorCode":"MFT-7415",
    "errorKey":"MFT_UNSUPPORTED_ARTIFACT_TYPE",
    "errorMessage":"Unsupported artifact type found. Artifact type: {TYPE}."
}

Examples

Example of Response Body

The following example shows how to export MFT artifacts in zip format and configPlan file in XML format by submitting a GET request on the REST resource using cURL.

curl -i -X GET -u <username>:<password> -H "Content-Type: multipart/form-data" http://host:port/mftapp/rest/v1/artifacts?sourceName=test2

The following example shows the contents of the response body in xml format:

<mft-artifacts version="12.2.x.x">  
	<source> 
		<file name="test2">
			<generalProperties contentFolder="/.../user_projects/domains/base_domain/mft/storage/t3" minimumAge="0" includeContentInSubfolder="true"/> 
			<advancedProperties triggerFileStrategy="Once only" triggerFileName="1.txt" maxRaiseSize="2000" singleThreaded="true" threadCount="1">
				 <content includeExcludePatternType="Wildcard" includeFiles="*.txt"/> 
			</advancedProperties> 
			<processingActions>
				<Compress order="1" level="Default Compression"> 
 				</Compress>  
			</processingActions> 
			<SourceSchedule> 
				<Polling enable="false" pollingInterval="60">  
				</Polling>
				<Event enable="true" enableSecurity="true"> 
					<security> 
 						<group name="AdminChannelUsers"/>
						<role name="MFTAdmin"/> 
					</security>  
				</Event>  
			</SourceSchedule> 
		</file>
 	</source>
</mft-artifacts>