REST API for Oracle Managed File Transfer

Get the download links for the MFT MDS archive and config plan file

get

/mftapp/rest/v1/applicationMetadata

Gets the absolute URLs to the metadata archive and config plan file. Use 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: string

Name of the artifact to be exported
artifactType: string

Type of the artifact to be exported, only support TRANSFER artifactType
label: string

Label of the deployment to be exported
longFormat: boolean

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

Response

Supported Media Types

application/json

200 Response

Root Schema : schema

Type: object

Show Source

links(required): 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(required): string
mediaType(required): string
rel(required): 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: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "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

The error key that Oracle Managed File Transfer returns.
errorMessage: 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: "
}

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

curl -i -X GET -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/applicationMetadata

Example of Response Body

{
    "links": [
        {
            "rel": "metadataArchive",
            "href": "http://<host>:<port>/mftapp/rest/v1/applicationMetadata/archive",
            "mediaType": "application/zip"
        },
        {
            "rel": "configPlan",
            "href": "http://<host>:<port>/mftapp/rest/v1/applicationMetadata/configPlan",
            "mediaType": "application/octet-stream"
        }
    ]
}