Jump to

• Request
• Response
• Examples

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(optional): boolean
  Flag to view the preview the import without actually importing metadata.

Body ()

A body of type:

• multipart/form-data

Root Schema : schema

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• artifactsAdded(optional): string
• artifactsModified(optional): string
• configPlanOverrideResultSummmary(optional): array configPlanOverrideResultSummmary
• failedTransfers(optional): array failedTransfers
• skippedTransfers(optional): 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

• [0]: 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

• [0]: string

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

Nested Schema : skippedTransfers

Type: array

Show Source

• [0]: string

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

Nested Schema : items

Type: object

Show Source

• artifactName(optional): string
• artifactType(optional): string
• attributeName(optional): string
• newValue(optional): string
• oldValue(optional): string

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

500 Response

Body ()

Root Schema : Error information.

Type: object

Title: Error information.

Show Source

• errorCode(optional): string
  The error code that Oracle Managed File Transfer returns.
• errorKey(optional): string
  A message describing the error that Oracle Managed File Transfer returns.
• errorMessage(optional): 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

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://example.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, /scratch/export.zip.

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