REST API for Oracle Managed File Transfer

Import the MFT metadata into the MFT MDS store

put

/mftapp/rest/v1/applicationMetadata

Imports 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: boolean

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

Form Parameters

artifacts: file
json(required): object

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

artifactsAdded: string
artifactsModified: string
configPlanOverrideResultSummmary: array configPlanOverrideResultSummmary
failedTransfers: array failedTransfers
skippedTransfers: array skippedTransfers

{
    "type":"object",
    "properties":{
        "artifactsAdded":{
            "type":"string"
        },
        "artifactsModified":{
            "type":"string"
        },
        "skippedTransfers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "failedTransfers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "configPlanOverrideResultSummmary":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "type":"string"
                    },
                    "artifactType":{
                        "type":"string"
                    },
                    "attributeName":{
                        "type":"string"
                    },
                    "oldValue":{
                        "type":"string"
                    },
                    "newValue":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : configPlanOverrideResultSummmary

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "artifactName":{
                "type":"string"
            },
            "artifactType":{
                "type":"string"
            },
            "attributeName":{
                "type":"string"
            },
            "oldValue":{
                "type":"string"
            },
            "newValue":{
                "type":"string"
            }
        }
    }
}

Nested Schema : failedTransfers

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : skippedTransfers

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "artifactName":{
            "type":"string"
        },
        "artifactType":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        },
        "oldValue":{
            "type":"string"
        },
        "newValue":{
            "type":"string"
        }
    }
}

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-2351",
    "errorKey":"MFT_IMPORT_ERROR",
    "errorMessage":"Error occurred while importing the metadata."
}

Examples

The following cURL command shows how to import metadata from a remote machine. For more information, see Use cURL.

cURL Command

To import the metadata archive:

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

Run this cURL command from a folder where export.zip exists. Otherwise, provide the 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.