Jump to

• Request
• Response
• Examples

Get schema of the resource in string format

get

/mftapp/rest/v1/metadata-catalog/{resource}

Retrieve resource catalog.

Request

Path Parameters

• resource: string
  Name of the resource for which schema is requested

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : RAML Schema.

Type: object

Title: RAML Schema.

Show Source

• schema(optional): string
  RAML schema of the resource

{
    "title":"RAML Schema.",
    "type":"object",
    "properties":{
        "schema":{
            "type":"string",
            "description":"RAML schema of the resource"
        }
    }
}

500 Response

Something went wrong

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.

{
    "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."
}

Back to Top

Examples

The following cURL examples shows how to get schema of a resource by submitting a GET request on the REST resource using cURL.

curl -i -X GET -u <username>:<password> -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/metadata-catalog/sources 

Example of Response Body: 200 Response

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

#%RAML 0.8
title: REST API for Application Metadata of Oracle Managed File Transfer
version: v1
securitySchemes:
  - basicAuthentication:
     description: |
      Basic Authentication required
     type: Basic Authentication
securedBy: [basicAuthentication]
schemas:
  - source-xml: '{}'
  - source: '{ "$schema": "http://json-schema.org/draft-04/schema#", "properties": { "sources": { "type": "array", "description": "Sources discovered", "items":[ { "type":"object", "properties":{ "name":{ "description":"Name of the source.", "type":"string"  }, "url":{ "description":"URL of the source.", "type":"string"  }, "bindingType":{ "description":"Binding type of the source.", "type":"string"  }, "eventInvokeUrl":{ "description":"URL at which to invoke the event.", "type":"string" } } } ] } } }'
  - error-xml: '{}'
  - error: '{ "$schema": "http://json-schema.org/draft-04/schema#", "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." } } }'
/sources:
  displayName: Sources
  get:
    description: Get available active sources. Gets the list of sources active in MFT based on the criteria like application type, binding type, etc. The response contains the list of sources with URLs.
    queryParameters:
      searchFilter:
        displayName: search filter
        description: Full/partial Name of source(s) to be discovered
        type: string
        required: false
        example: file_src
      application:
        displayName: application type
        description: Type of the application binding you want to discover
        type: string
        required: false
        example: ODI
      bindingType:
        displayName: binding type
        description: Binding type of source you want to discover
        type: string
        required: false
        example: file
      onlyEventEnabled:
        displayName: only event enabled
        description: Discover only event enabled sources 
        type: boolean
        required: false
        example: true
    responses:
      200:
        body:
          application/json:
            schema: source
            example: '{ "sources": [ { "name": "src1", "url": "/scratch/demo", "bindingType": "File", "eventInvokeUrl": "/mftapp/rest/v1/events" }, { "name": "src2", "url": "/scratch/username", "bindingType": "File", "eventInvokeUrl": "/mftapp/rest/v1/events" } ] }'
      500:
        description: Something went wrong
        body:
          application/json:
            schema: error
            example: '{ "errorCode":"MFT-5403" "errorKey":"MFT_WS_DISCOVERY_COULD_NOT_QUERY_MFT_SOURCES" "errorMessage":"Discovery service is unable to query MFT Sources for the given application ODI and search Filter file1." }'          

Back to Top