REST API for Oracle Managed File Transfer

Get the list of available resources

get

/mftapp/rest/v1/metadata-catalog

Lists each resource name with alternate and describe links which can be used to get the meta data of the resource

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Root Schema : resourceCatalog

Type: object

Show Source

items(optional): array items

Information about the MFT resources.
links(optional): array links

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"Information about the MFT resources.",
            "items":[
                {
                    "type":"object",
                    "properties":{
                        "name":{
                            "description":"Name of the resource.",
                            "type":"string"
                        },
                        "links":{
                            "type":"array",
                            "items":[
                                {
                                    "type":"object",
                                    "properties":{
                                        "rel":{
                                            "description":"Relationship to resource.",
                                            "type":"string"
                                        },
                                        "href":{
                                            "description":"Reference to resource.",
                                            "type":"string"
                                        },
                                        "mediaType":{
                                            "description":"Media type of response.",
                                            "type":"string"
                                        }
                                    }
                                }
                            ]
                        }
                    }
                }
            ]
        },
        "links":{
            "type":"array",
            "items":[
                {
                    "type":"object",
                    "properties":{
                        "rel":{
                            "description":"Relationship to resource.",
                            "type":"string"
                        },
                        "href":{
                            "description":"Reference to resource.",
                            "type":"string"
                        },
                        "mediaType":{
                            "description":"Media type of response.",
                            "type":"string"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : items

Type: array

Information about the MFT resources.

Show Source

Array of: object items-items[0]

{
    "type":"array",
    "description":"Information about the MFT resources.",
    "items":[
        {
            "type":"object",
            "properties":{
                "name":{
                    "description":"Name of the resource.",
                    "type":"string"
                },
                "links":{
                    "type":"array",
                    "items":[
                        {
                            "type":"object",
                            "properties":{
                                "rel":{
                                    "description":"Relationship to resource.",
                                    "type":"string"
                                },
                                "href":{
                                    "description":"Reference to resource.",
                                    "type":"string"
                                },
                                "mediaType":{
                                    "description":"Media type of response.",
                                    "type":"string"
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

Nested Schema : links

Type: array

Show Source

Array of: object links-items[0]

{
    "type":"array",
    "items":[
        {
            "type":"object",
            "properties":{
                "rel":{
                    "description":"Relationship to resource.",
                    "type":"string"
                },
                "href":{
                    "description":"Reference to resource.",
                    "type":"string"
                },
                "mediaType":{
                    "description":"Media type of response.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : items-items[0]

Type: object

Show Source

links(optional): array links
name(optional): string

Name of the resource.

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Name of the resource.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":[
                {
                    "type":"object",
                    "properties":{
                        "rel":{
                            "description":"Relationship to resource.",
                            "type":"string"
                        },
                        "href":{
                            "description":"Reference to resource.",
                            "type":"string"
                        },
                        "mediaType":{
                            "description":"Media type of response.",
                            "type":"string"
                        }
                    }
                }
            ]
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object links-items[0]

{
    "type":"array",
    "items":[
        {
            "type":"object",
            "properties":{
                "rel":{
                    "description":"Relationship to resource.",
                    "type":"string"
                },
                "href":{
                    "description":"Reference to resource.",
                    "type":"string"
                },
                "mediaType":{
                    "description":"Media type of response.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : links-items[0]

Type: object

Show Source

href(optional): string

Reference to resource.
mediaType(optional): string

Media type of response.
rel(optional): string

Relationship to resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relationship to resource.",
            "type":"string"
        },
        "href":{
            "description":"Reference to resource.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type of response.",
            "type":"string"
        }
    }
}

Nested Schema : links-items[0]

Type: object

Show Source

href(optional): string

Reference to resource.
mediaType(optional): string

Media type of response.
rel(optional): string

Relationship to resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "description":"Relationship to resource.",
            "type":"string"
        },
        "href":{
            "description":"Reference to resource.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type of response.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "items":[
        {
            "name":"events",
            "links":[
                {
                    "rel":"alternate",
                    "href":"http://host:port/mftapp/rest/v1/metadata-catalog/events",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"describes",
                    "href":"http://host:port/mftapp/rest/v1/events"
                }
            ]
        },
        {
            "name":"sources",
            "links":[
                {
                    "rel":"alternate",
                    "href":"http://host:port/mftapp/rest/v1/metadata-catalog/sources",
                    "mediaType":"application/schema+json"
                },
                {
                    "rel":"describes",
                    "href":"http://host:port/mftapp/rest/v1/sources"
                }
            ]
        }
    ],
    "links":[
        {
            "rel":"alternate",
            "href":"http://host:port/mftapp/rest/v1/metadata-catalog/catalog",
            "mediaType":"application/schema+json"
        },
        {
            "rel":"self",
            "href":"http://host:port/mftapp/rest/v1/metadata-catalog/"
        }
    ]
}

500 Response

Something went wrong

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.

{
    "title":"Error information.",
    "type":"object",
    "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-5445",
    "errorKey":"MFT_REST_UNABLE_TO_LIST_RESOURCES_CATALOG",
    "errorMessage":"Unable to list the resources catalog of MFT RESTful services."
}

Examples

Example of Response Body

The following example shows how to get metadata catalog by submitting a GET request on the REST resource using cURL.

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

The following example shows the contents of the response body for a successful request in json format:

{
  "items": [
    {
      "name": "events",
      "links": [
        {
          "rel": "alternate",
          "href": "http://host:port/mftapp/rest/v1/metadata-catalog/events",
          "mediaType": "application/schema+json"
        },
        {
          "rel": "describes",
          "href": "http://host:port/mftapp/rest/v1/events"
        }
      ]
    },
    {
      "name": "sources",
      "links": [
        {
          "rel": "alternate",
          "href": "http://host:port/mftapp/rest/v1/metadata-catalog/sources",
          "mediaType": "application/schema+json"
        },
        {
          "rel": "describes",
          "href": "http://host:port/mftapp/rest/v1/sources"
        }
      ]
    },
    {
      "name": "applicationMetadata",
      "links": [
        {
          "rel": "alternate",
          "href": "http://host:port/mftapp/rest/v1/metadata-catalog/applicationMetadata",
          "mediaType": "application/schema+json"
        },
        {
          "rel": "describes",
          "href": "http://host:port/mftapp/rest/v1/applicationMetadata"
        }
      ]
    },
    {
      "name": "artifacts",
      "links": [
        {
          "rel": "alternate",
          "href": "http://host:port/mftapp/rest/v1/metadata-catalog/artifacts",
          "mediaType": "application/schema+json"
        },
        {
          "rel": "describes",
          "href": "http://host:port/mftapp/rest/v1/artifacts"
        }
      ]
    },
    {
      "name": "purges",
      "links": [
        {
          "rel": "alternate",
          "href": "http://host:port/mftapp/rest/v1/metadata-catalog/purges",
          "mediaType": "application/schema+json"
        },
        {
          "rel": "describes",
          "href": "http://host:port/mftapp/rest/v1/purges"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "alternate",
      "href": "http://host:port/mftapp/rest/v1/metadata-catalog/catalog",
      "mediaType": "application/schema+json"
    },
    {
      "rel": "self",
      "href": "http://host:port/mftapp/rest/v1/metadata-catalog/"
    }
  ]
}