Jump to

• Request
• Response

Get the download links for the MFT MDS archive and Config Plan files

get

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

The response contains the absolute URLs referencing to the Metadata archive and Config file. User artifactName and artifactType parameters to export the transfer and related metadata. To export the artifact from a deployment, provide the label. Use the logFormat flag to get a partial/full details in the config plan file.

Request

Query Parameters

• artifactName(optional): string
  Name of the artifact to be exported
• artifactType(optional): string
  Type of the artifact to be exported, only support TRANSFER artifactType
• label(optional): string
  Label of the deployment to be exported
• longFormat(optional): boolean
  Option to export the long format having full attribute details in config plan file

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• links: array links
  Links to metadata files.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "description":"Links to metadata files.",
            "items":[
                {
                    "type":"object",
                    "properties":{
                        "rel":{
                            "type":"string"
                        },
                        "href":{
                            "type":"string"
                        },
                        "mediaType":{
                            "type":"string"
                        }
                    },
                    "required":[
                        "rel",
                        "href",
                        "mediaType"
                    ]
                },
                {
                    "type":"object",
                    "properties":{
                        "rel":{
                            "type":"string"
                        },
                        "href":{
                            "type":"string"
                        },
                        "mediaType":{
                            "type":"string"
                        }
                    }
                }
            ]
        }
    },
    "required":[
        "links"
    ]
}

Nested Schema : links

Type: array

Links to metadata files.

Show Source

• [0]: object 0
• [1]: object 1

{
    "type":"array",
    "description":"Links to metadata files.",
    "items":[
        {
            "type":"object",
            "properties":{
                "rel":{
                    "type":"string"
                },
                "href":{
                    "type":"string"
                },
                "mediaType":{
                    "type":"string"
                }
            },
            "required":[
                "rel",
                "href",
                "mediaType"
            ]
        },
        {
            "type":"object",
            "properties":{
                "rel":{
                    "type":"string"
                },
                "href":{
                    "type":"string"
                },
                "mediaType":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : 0

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href",
        "mediaType"
    ]
}

Nested Schema : 1

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "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
  The error key that Oracle Managed File Transfer returns.
• errorMessage(optional): 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: "
}