REST API for Oracle Managed File Transfer

Download the metadata archive or config plan file

get

/mftapp/rest/v1/applicationMetadata/{file}

Downloads either the metadata archive or config plan file.

Request

Path Parameters

file(required): string

The file to be downloaded

Query Parameters

artifactName: string

Name of the artifact to be exported
artifactType: string

Type of the artifact to be exported
label: string

Label of the deployment to be exported
longFormat: boolean

Option to export the long format having full attribute details in config plan file

Response

Supported Media Types

application/json
application/octet-stream

200 Response

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

A message describing the error that Oracle Managed File Transfer returns.
errorMessage: string

A message that describes 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":"A message describing the error that Oracle Managed File Transfer returns."
        },
        "errorMessage":{
            "type":"string",
            "description":"A message that describes the error that Oracle Managed File Transfer returns"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"MFT-2301",
    "errorKey":"MFT_EXPORT_ERROR",
    "errorMessage":"Error occurred while exporting the metadata."
}

Examples

The following cURL command shows how to download the metadata resource by submitting a GET request on the REST resource using cURL. For more information, see Use cURL.

cURL Command

To download the metadata archive:

curl -o export.zip -LOk -D- -u <username>:<password> -X GET -H "Content-Type: application/zip" http://<host>:<port>/mftapp/rest/v1/applicationMetadata/archive

To download the config plan:

curl -o <filename.xml> -LOk -D- -u <username>:<password> -X GET -H "Content-Type: application/octet-stream" http://<host>:<port>/mftapp/rest/v1/applicationMetadata/configPlan

Example

<?xml version='1.0' encoding='UTF-8'?>
<MftConfigPlan xmlns="http://xmlns.oracle.com/mft/configPlan/v1"> 
		<global>
		<!--Add global search and replace rules. Example :
		<searchReplace>
			<search>http://my-test-server</search>
			<replace>http://my-server</replace>
		</searchReplace>-->
		</global>
		<!--Add source level search and replace rules. Example : 
		<sourcePattern namePattern="*"> 
			<searchReplace>
				<search>http://my-test-server</search>
				<replace>http://my-server</replace> 
		</searchReplace> 
</sourcePattern>--> 
<!--Add target level search and replace rules. Example :
<targetPattern namePattern="*"> 
		<searchReplace> 
				<search>http://my-test-server</search>  
				<replace>http://my-server</replace>
		</searchReplace> 
</targetPattern>-->
<!--add search and replace rules for the artifact properties-->
<sources>
		<source name="File UCM">
			<binding technologyBinding="File"> 
				<attribute name="Content Folder">
					<replace>/scratch/ucm</replace>  
				</attribute>
			</binding>
		</source>
		<source name="SFTP R">   
			<binding technologyBinding="sFTP Remote">
				<attribute name="Host Name"> 
					<replace>test.us.oracle.com</replace> 
				</attribute>
				<attribute name="Content Folder">
					<replace>/scratch/user/test</replace> 
				</attribute>
 				<attribute name="Password">
					<replace>pw_key_2ce5a3f2-a8a3-92d9717a1b82</replace>
				</attribute> 
				<attribute name="Control Port">  
					<replace>22</replace>
				</attribute>
				<attribute name="User Name">
					<replace>user</replace> 
				</attribute> 
		</binding>
	</source> 
	<source name="SFTP_L">
		<binding technologyBinding="sFTP Remote"> 
			<attribute name="Host Name">
				<replace>test.us.oracle.com</replace>
			</attribute>
			<attribute name="Content Folder">
				<replace>/scratch/storage</replace>   
			</attribute>
		</binding>  
	</source> 
	<source name="File Src">
		<binding technologyBinding="File">
			<attribute name="Content Folder"> 
				<replace>/test</replace>  
			</attribute>
		</binding> 
	</source>
	<source name="SOAP">
		<binding technologyBinding="SOAP">
			<attribute name="URL"> 
				<replace>test</replace>
  		</attribute> 
		</binding>
	</source>
	<source name="File"> 
		<binding technologyBinding="File"> 
			<attribute name="Content Folder">
				<replace>/scratch/in</replace> 
			</attribute>
		</binding>
 </source> 
</sources>
<targets>
		<target name="sftp_windows">
			<binding technologyBinding="sFTP Remote">
 				<attribute name="Host Name">
					<replace>test.us.oracle.com</replace>
				</attribute>
				<attribute name="Content Folder"> 
					<replace>/scratch/user/sftptest_user</replace>
				</attribute> 
				<attribute name="Password">
					<replace>pw_key_eb9cf322-b396-9bf7b66cd013</replace>
				</attribute>   
				<attribute name="Control Port"> 
 					<replace>22</replace> 
				</attribute> 
				<attribute name="User Name">   
					<replace>user</replace> 
				</attribute>  
		</binding> 
	</target><target name="SOA Tgt">  
		<binding technologyBinding="SOAP" applicationBinding="SOA"> 
			<attribute name="Port"> 
				<replace>MFTServicePort</replace> 
			</attribute><attribute name="Service"> 
				<replace>MFTService</replace> 
			</attribute> <attribute name="URL">
				<replace>test</replace>
			</attribute> 
			<attribute name="Action"> 
 				<replace>http://xmlns.oracle.com/fmw/mft/soap/mftSubmit</replace>
			</attribute>
 		</binding>
	</target>  
	<target name="Storage">
		<binding technologyBinding="Oracle Storage Cloud Service">
			<attribute name="User Name">  
				<replace>env_mgr@criepi.denken.or.jp</replace> 
			</attribute>  
			<attribute name="Service Name"> 
				<replace>Storage-ehia-test</replace> 
			</attribute> 
			<attribute name="Password">
				<replace>pw_key_c560b5fd-a336-be4174afd7a0</replace>
			</attribute>  
 			<attribute name="Service URL">
					<replace>https://ehia-test.us.storage.oraclecloud.com</replace>
			</attribute>
 			<attribute name="Container Name">
					<replace>UserInfoLinkage</replace> 
			</attribute>  
		</binding>
	</target>
	<target name="sftp_Remote">
			<binding technologyBinding="sFTP Remote">
		<attribute name="Host Name">  
				<replace>test.us.oracle.com</replace> 
		</attribute> 
		<attribute name="Content Folder">
				<replace>/scratch/user/test</replace>
		</attribute><attribute name="Password">   
				<replace>pw_key_aac0648e-948a-1d1f1ce0091e</replace>
		</attribute>   
		<attribute name="Control Port">
				<replace>22</replace> 
		</attribute> 
		<attribute name="User Name">
 				<replace>user</replace> 
 		</attribute> 
	</binding>  
</target> 
<target name="File Tgt"> 
		<binding technologyBinding="File"> 
		<attribute name="Content Folder">   
				<replace>/scratch/out</replace> 
		</attribute> 
	</binding> 
</target>  
<target name="UCM"> 
			<binding technologyBinding="WebCenter"> 
				<attribute name="User Name">
					<replace>weblogic</replace> 
 				</attribute>
				<attribute name="Connection URL">  
						<replace>http://test.us.oracle.com:16200/cs/idcplg</replace> 
				</attribute>
				<attribute name="Password"> 
						<replace>pw_key_314e011d-bae7-148015cdca00</replace> 
				</attribute>
		</binding>
	</target>
</targets>
<transfers>
</transfers> 
	<include> 
		<transferName>FTP to File</transferName>
		<transferName>R SFTP to File</transferName> 
		<transferName>file to storage</transferName> 
		<transferName>File wc to UCM</transferName>
		<transferName>Test</transferName> 
		<transferName>File To File</transferName>
	</include>
</MftConfigPlan>