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

Body

Root Schema : resourceCatalog

Type: object

Properties

items: Type: array items

Information about the MFT resources.
links: Type: array links

Nested Schema : items

Type: array

Information about the MFT resources.

Items

Type: object items-items[0]

Nested Schema : links

Type: array

Items

Type: object links-items[0]

Nested Schema : items-items[0]

Type: object

Properties

links: Type: array links
name: Type: string

Name of the resource.

Nested Schema : links

Type: array

Items

Type: object links-items[0]

Nested Schema : links-items[0]

Type: object

Properties

href: Type: string

Reference to resource.
mediaType: Type: string

Media type of response.
rel: Type: string

Relationship to resource.

Nested Schema : links-items[0]

Type: object

Properties

href: Type: string

Reference to resource.
mediaType: Type: string

Media type of response.
rel: Type: string

Relationship to resource.

Example 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

Body

Root Schema : Error information.

Type: object

Title: Error information.

Properties

errorCode: Type: string

The error code that Oracle Managed File Transfer returns.
errorKey: Type: string

The error key that Oracle Managed File Transfer returns.
errorMessage: Type: string

A message describing the error that Oracle Managed File Transfer returns.

Example application/json


{
    "errorCode":"MFT-5445",
    "errorKey":"MFT_REST_UNABLE_TO_LIST_RESOURCES_CATALOG",
    "errorMessage":"Unable to list the resources catalog of MFT RESTful services."
}