REST API for Oracle Managed File Transfer Cloud Service 12.2.1.2

Import the MFT metadata into the MFT MDS store

put

/mftapp/rest/v1/mftapp/rest/v1/applicationMetadata

Supports importing metadata along with optional config plan file which allows to override the attributes in the metadata files.

Request

Supported Media Types

multipart/form-data

Query Parameters

previewModeFlag: Type: boolean

Flag to view the preview the import without actually importing metadata.

Body Parameter

A body of type:

Root Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/parameters/1/schema

multipart/form-data

Response

Supported Media Types

application/json

200 Response

Body

Root Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema

Type: object

Properties

artifactsAdded: Type: string
artifactsModified: Type: string
configPlanOverrideResultSummmary: Type: array /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/configPlanOverrideResultSummmary
failedTransfers: Type: array /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/failedTransfers
skippedTransfers: Type: array /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/skippedTransfers

Nested Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/configPlanOverrideResultSummmary

Type: array

Items

Type: object /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/configPlanOverrideResultSummmary/items

Nested Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/failedTransfers

Type: array

Items

Type: string

Nested Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/skippedTransfers

Type: array

Items

Type: string

Nested Schema : /paths/~1mftapp~1rest~1v1~1applicationMetadata/put/responses/200/schema/properties/configPlanOverrideResultSummmary/items

Type: object

Properties

artifactName: Type: string
artifactType: Type: string
attributeName: Type: string
newValue: Type: string
oldValue: Type: string

500 Response

Body

Root Schema : Error information.

Type: object

Title: Error information.

Properties

errorCode: Type: string

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

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

A message that describes the error that Oracle Managed File Transfer returns

Example application/json


{
    "errorCode":"MFT-2351",
    "errorKey":"MFT_IMPORT_ERROR",
    "errorMessage":"Error occurred while importing the metadata."
}

Examples

Example of cURL command to import metadata from a remote machine

The API mftapp-rest-v1-applicationMetadata-put supports importing metadata from a remote server.

The following cURL command shows the import command:

curl -X PUT -H "Content-Type: multipart/form-data;" -F "archive=@export.zip" -F "configPlan=@mftConfig.xml" http://test.us.oracle.com:5000/mftapp/rest/v1/applicationMetadata  -u username:password

Run the above mentioned cURL command from folder where export.zip exists, else provide complete path for example, /net/test.us.oracle.com/scratch/export.zip.

It is recommended that you use MFT console or MFT REST API for export/import of files.