ソースのトリガー
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
トリガーするソースの名前。
ネストされたスキーマ: properties
型:
object
タイトル:
properties
ソース名と一緒に渡されるプロパティ。
ソースを表示
- entry(optional): array entry
タイトル:
entry
それぞれのエントリが'string'のキー値のペアです。
ネストされたスキーマ: entry
型:
array
タイトル:
entry
それぞれのエントリが'string'のキー値のペアです。
ソースを表示
- Array of: object アイテム
タイトル:
items
ネストされたスキーマ: items
型:
object
タイトル:
ソースを表示
items
- key(optional): string
パターン:
^(/[^/]+)+$
- value(optional): string
パターン:
^(/[^/]+)+$
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
ソースが正常にトリガーされると、レスポンスが戻されます。
ルート・スキーマ : eventSessionId
型:
object
タイトル:
ソースを表示
eventSessionId
- eventSessionId(optional): string
作成されたイベントのID。
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から返されるエラーを説明するメッセージ。
例
次の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" }