Oracle Managed File Transfer REST API

ソースのトリガー

post

/mftapp/rest/v1/events

指定したソースからのファイル転送をトリガーし、ファイルを処理するためにMFTに送ります。eventSessionidという一意のIDが返されます。これを使用して、イベント・ステータスの追跡や結果のインスタンス詳細の取得を行います。

リクエスト

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

application/json

トリガーするソースの名前。許可されるソースは、ファイル、FTPリモート、sFTPリモート、WebCenterおよびOracle Storage Cloud Serviceです。

JCAソースのためにサポートされているパラメータ(ファイル、FTPリモート、sFTPリモート): PatternType - ワイルドカードまたは正規表現、IncludePattern - 任意のワイルドカードまたは正規表現フィルタ文字列、ExcludePattern - 任意のワイルドカードまたは正規表現フィルタ文字列。PatternTypeは、パターンを渡す場合の必須入力パラメータです。
Oracle Cloud Storageソース用にサポートされているパラメータ: PayloadKey、Path、Delimiter
WebCenterソース用にサポートされているパラメータ: DocName、DocId、RevisionSelectionMethod、Rendition、Querytext、QueryFormat、SecurityGroup、DocumentAccount

ルート・スキーマ : schema

型: object

ソースを表示

properties(optional): object properties

タイトル: properties

ソース名と一緒に渡されるプロパティ。
sourceName(optional): string

トリガーするソースの名前。

{
    "type":"object",
    "properties":{
        "sourceName":{
            "type":"string",
            "description":"Name of the source to be triggered."
        },
        "properties":{
            "title":"properties",
            "type":"object",
            "description":"Properties passed with the source name.",
            "properties":{
                "entry":{
                    "description":"Each entry is a key value pair of 'string'.",
                    "type":"array",
                    "title":"entry",
                    "items":{
                        "title":"items",
                        "type":"object",
                        "properties":{
                            "key":{
                                "type":"string",
                                "pattern":"^(/[^/]+)+$"
                            },
                            "value":{
                                "type":"string",
                                "pattern":"^(/[^/]+)+$"
                            }
                        }
                    }
                }
            }
        }
    }
}

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

型: object

タイトル: properties

ソース名と一緒に渡されるプロパティ。

ソースを表示

entry(optional): array entry

タイトル: entry

それぞれのエントリが'string'のキー値のペアです。

{
    "title":"properties",
    "type":"object",
    "description":"Properties passed with the source name.",
    "properties":{
        "entry":{
            "description":"Each entry is a key value pair of 'string'.",
            "type":"array",
            "title":"entry",
            "items":{
                "title":"items",
                "type":"object",
                "properties":{
                    "key":{
                        "type":"string",
                        "pattern":"^(/[^/]+)+$"
                    },
                    "value":{
                        "type":"string",
                        "pattern":"^(/[^/]+)+$"
                    }
                }
            }
        }
    }
}

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

型: array

タイトル: entry

それぞれのエントリが'string'のキー値のペアです。

ソースを表示

Array of: object アイテム

タイトル: items

{
    "description":"Each entry is a key value pair of 'string'.",
    "type":"array",
    "title":"entry",
    "items":{
        "title":"items",
        "type":"object",
        "properties":{
            "key":{
                "type":"string",
                "pattern":"^(/[^/]+)+$"
            },
            "value":{
                "type":"string",
                "pattern":"^(/[^/]+)+$"
            }
        }
    }
}

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

型: object

タイトル: items

ソースを表示

key(optional): string

パターン: ^(/[^/]+)+$
value(optional): string

パターン: ^(/[^/]+)+$

{
    "title":"items",
    "type":"object",
    "properties":{
        "key":{
            "type":"string",
            "pattern":"^(/[^/]+)+$"
        },
        "value":{
            "type":"string",
            "pattern":"^(/[^/]+)+$"
        }
    }
}

トップに戻る

レスポンス

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

application/json

200レスポンス

ソースが正常にトリガーされると、レスポンスが戻されます。

ルート・スキーマ : eventSessionId

型: object

タイトル: eventSessionId

ソースを表示

eventSessionId(optional): string

作成されたイベントのID。

{
    "title":"eventSessionId",
    "type":"object",
    "properties":{
        "eventSessionId":{
            "type":"string",
            "description":"The ID of the event created."
        }
    }
}

500レスポンス

エラー情報。

ルート・スキーマ : errors

型: object

タイトル: errors

ソースを表示

errorCode(optional): string

Oracle Managed File Transferから返されるエラー・コード。
errorKey(optional): string

Oracle Managed File Transferから返されるエラー・キー。
errorMessage(optional): 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."
        }
    }
}

トップに戻る

例

次のcURLの例は、cURLを使用してRESTリソースにPOSTリクエストを発行して、指定したソースからのファイル転送をトリガーする方法を示しています。

cURLコマンド

curl -x post ???u <username>:<password> -H Content-Type:application/json -d @ '{"sourceName": "SFTP Remote Source","properties":{"entry":[{"key":"PatternType","value":"wildcard"},{"key" :"ExcludePattern","value":"*sh"}]}}' http://localhost:port/mftapp/rest/v1/events

リクエスト本文の例

JSON形式のリクエスト本文のコンテンツの例を次に示します。

{
  "sourceName": "src1",
  "properties": {
    "entry": [
      {
        "key": "name1",
        "value": "value1"
      },
      {
        "key": "name2",
        "value": "value2"
      }
    ]
  }
}

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

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

{
	"eventSessionId":"799AE14A-9E37-42B9-9789-8F005039953E"
}

例 - レスポンス本文の例: 500レスポンス

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

  {
	"errorCode":"MFT-5423"
	"errorKey":"MFT_WS_EVENT_SERVICE_SOURCE_DONT_EXITS_OR_NOT_DEPLOYED"
	"errorMessage":"Error in processing EventService request. The source {source} either doesn't exist or not deployed"             
  }

トップに戻る