1. REST API for Oracle Managed File Transfer
  2. Tasks
  3. MFT Catalog Service

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.

Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : resourceCatalog
Type: object
Show Source
Nested Schema : items
Type: array
Information about the MFT resources.
Show Source
Nested Schema : items-items[0]
Type: object
Show Source
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
Body ()
Root Schema : Error information.
Type: object
Title: Error information.
Show Source
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."
}
Back to Top

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/"
    }
  ]
}
Back to Top