移動先

• リクエスト
• レスポンス
• 例

使用可能なアクティブ・ソースの取得

get

/mftapp/rest/v1/sources

アプリケーション・タイプやバインディング・タイプなどの条件に基づいて、MFTでアクティブなソースのリストを取得します。レスポンスには、URLを含むソースのリストが含まれます。問合せパラメータを指定せずにこのAPIを起動すると、bindingTypeを含むソースのみがSOA、SOAP、ODIおよびOSBなどのWebサービスとして取得されます。他のソースを取得するには、bindingTypeまたはアプリケーション・パラメータ(あるいはその両方)を問合せに渡します。アプリケーション・パラメータおよびbindingTypeパラメータを指定しない場合、searchFilterフィルタおよびonlyEventEnabledフィルタは無視されます。サポートされるアプリケーション・タイプには、B2B、Healthcare、OSB、SOAおよびODIがあります。サポートされるバインディング・タイプには、Embedded-FTP、Embedded-SSH-FTP、ファイル、FTP、SSH-FTP、WS、B2B、Healthcare、OCSS、およびRIDCがあります。

リクエスト

問合せのパラメータ

• application: string
  検出しようとするアプリケーション・バインディングのタイプ
• bindingType: string
  検出しようとするソースのバインディング・タイプ
• onlyEventEnabled: boolean
  イベントに対応するソースのみを検出
• searchFilter: string
  検出するソースの完全な名前または名前の一部

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

アクティブ・ソースを説明します。

本文 ()

ルート・スキーマ : activeSources

型: object

タイトル: activeSources

ソースを表示

• sources: array sources
  タイトル: sources

  検出されたソース

{
    "title":"activeSources",
    "type":"object",
    "properties":{
        "sources":{
            "title":"sources",
            "type":"array",
            "description":"Sources discovered",
            "items":{
                "title":"items",
                "type":"object",
                "properties":{
                    "name":{
                        "type":"string",
                        "description":"Name of the source."
                    },
                    "url":{
                        "type":"string",
                        "description":"URL of the source."
                    },
                    "bindingType":{
                        "type":"string",
                        "description":"Binding type of the source."
                    },
                    "eventInvokeUrl":{
                        "type":"string",
                        "description":"URL at which to invoke the event."
                    }
                }
            }
        }
    }
}

ネストされたスキーマ: sources

型: array

タイトル: sources

検出されたソース

ソースを表示

• Array of: object アイテム
  タイトル: items

{
    "title":"sources",
    "type":"array",
    "description":"Sources discovered",
    "items":{
        "title":"items",
        "type":"object",
        "properties":{
            "name":{
                "type":"string",
                "description":"Name of the source."
            },
            "url":{
                "type":"string",
                "description":"URL of the source."
            },
            "bindingType":{
                "type":"string",
                "description":"Binding type of the source."
            },
            "eventInvokeUrl":{
                "type":"string",
                "description":"URL at which to invoke the event."
            }
        }
    }
}

ネストされたスキーマ: items

型: object

タイトル: items

ソースを表示

• bindingType: string
  ソースのバインディング・タイプ。
• eventInvokeUrl: string
  起動するイベントのURL。
• name: string
  ソースの名前。
• url: string
  ソースのURL。

{
    "title":"items",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the source."
        },
        "url":{
            "type":"string",
            "description":"URL of the source."
        },
        "bindingType":{
            "type":"string",
            "description":"Binding type of the source."
        },
        "eventInvokeUrl":{
            "type":"string",
            "description":"URL at which to invoke the event."
        }
    }
}

500レスポンス

エラー情報。

本文 ()

ルート・スキーマ : errors

型: object

タイトル: errors

ソースを表示

• errorCode: string
  Oracle Managed File Transferから返されるエラー・コード。
• errorKey: string
  Oracle Managed File Transferから返されるエラー・キー。
• errorMessage: string
  Oracle Managed File Transferから返されるエラーを説明するメッセージ。

{
    "title":"errors",
    "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."
        }
    }
}

トップに戻る

例

レスポンス本文の例: 200レスポンス

次のcURLコマンドは、RESTリソースにGETリクエストを発行して、様々な問合せパラメータに基づいてソースの詳細を取得する方法を示しています:

すべてのファイル・ソースをリストするには:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" 'http://<host>:<port>/mftapp/rest/v1/sources?bindingType=file' 

名前に文字列abcが含まれるすべてのファイル・ソースをリストするには:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?bindingType=File&&searchFilter=abc

イベント対応FTPソースをすべて表示するには:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?bindingType=FTP&onlyEventEnabled=true

すべてのSOAソースをリストするには:

curl -I -X GET -u <username>:<password>  -H "Content-Type: application/json" http://host:port/mftapp/rest/v1/sources?application=soa

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(JSON形式)。

{
	"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レスポンス

次の例では、正常終了したリクエストのレスポンス本文のコンテンツを示しています(JSON形式):

{
  "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 {application} and search Filter {search filter}."
}

トップに戻る