Model Serve
- Model Serve
- 所有产品
PUT <server URL>/mftsaas/api/v1/filelisteners/<filelistener ID>
フィールド
| タイプ
| 必須
| 説明
|
---|---|---|---|
id
| String
| ○
| ファイルリスナに関連付けられているID番号。
|
name
| String
| ○
| ファイルリスナの名前。
|
description
| String
| -
| ファイルリスナの説明。
|
status
| String
| ○
| ファイルリスナのステータス。
|
agentGroup
| Numeric
| ○
| ファイルリスナの実行に使用されるSecure Agentを含むランタイム環境。
|
connectionType
| String
| ○
| ファイルリスナがリスニングする接続のタイプ。
|
connection
| String
| ○
| ファイルリスナがリスニングする接続。
|
folderPath
| String
| ○
| ファイルリスナがリスニングする接続上にあるフォルダへのパス。
|
filePattern
| String
| ○
| ファイルリスナがリスニングするファイル名パターン。
|
アクション後
| String
| -
| ファイルリスナがイベントをリスニングした後にファイルリスナが実行する必要のあるアクションを決定します。
ファイルパターンがインジケータファイルである場合にのみ、アクション後に [削除] を選択することができます。デフォルトは[なし]です。
次の接続タイプは、[アクション後]のオプションをサポートします。
|
patternType
| String
| ○
| ファイルパターン。
|
mandatory
| String
| -
| ルールの値が必須かどうかを定義します。
|
recursive
| String
| -
| ルールの値が再帰的かどうかを定義します。
|
scheduleDefinition
| String
| ○
| ファイルリスナを実行する頻度を定義します。
|
type
| String
| ○
| ファイルリスナを実行する頻度(毎日、毎週、または毎月)。
|
timezone
| String
| ○
| 開始時刻と終了時刻のタイムゾーン。
|
startDate
| Date/Time
| ○
| ファイルリスナの実行を開始する日付。
|
endDate
| Date/Time
| ○
| ファイルリスナの実行を終了する日付。
|
runIndefinitely
| String
| -
| ファイルリスナは無期限に実行されます。
|
startsAt
| Date/Time
| ○
| ファイルリスナが実行を開始する時刻。
|
endsAt
| Date/Time
| ○
| ファイルリスナが実行を終了する時刻。
|
frequency
| Numeric
| ○
| ファイルリスナがフォルダ内のファイルをチェックする頻度。
|
frequencyUnit
| String
| ○
| ファイルリスナがフォルダ内のファイルをチェックする頻度の単位(秒、分、時間)。
|
listenerEvents
| String
| ○
| ファイルリスナが、登録済みのサービスに通知を送信するタイミングを決定します。各イベントをtrueに設定した場合の応答は次のとおりです。
|
stopWhenRulesMet
| String
| -
| ファイルリスナは、リスナルールに合致するとフォルダのリスニングを停止します。
|
checkFileStability
| String
| -
| ファイルリスナは、登録済みのサービスに通知する前に、ファイル全体がフォルダにコピーされたかどうかを確認します。
|
stabilityCheckInterval
| Time
| -
| ファイルリスナがファイルの安定性を確認するために待機する時間(秒単位)。
checkFileStabilityオプションが true に設定されている場合にのみ、stabilityCheckIntervalフィールドに値を指定できます。
|
notifyExistingFiles
| String
| -
| ファイルリスナが初めて実行されたときにすでにリスニング対象フォルダにファイルがあった場合に通知を送信します。
|
excludeFileEventsWhenNotRunning
| String
| -
| ファイルリスナが実行されていないときに発生するファイルイベントを除外するかどうかを決定します。
|
continueOnError
| String
| -
| 一時的なネットワークの中断などのエラーが発生した場合に、ファイルリスナを再試行して実行し続けるかどうかを決定します。
|
emailIds
| String
| -
| ファイルリスナにエラーが発生した場合に通知を送信するための電子メールアドレスのリスト。
リスト内の電子メールアドレスを区切るには、カンマを使用します。
|
location
| String
| -
| プロジェクトフォルダの場所。
|
PUT <serverUrl>/public/core/v1/filelisteners Content-Type: application/json Accept:application/json Content-Type:application/json IDS-SESSION-ID:{{IDS-SESSION-ID}} { "description": "Demo", "status": "ENABLE", "location": { "folderId": "avVCKODMM0RdSmcNWDnrKi", "folderName": "New", "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" }, "agentGroup": "01000025000000000002", "connection": { "type": "local", "name": "", "connId": "", "local": true }, "listenerEvents":{ "arrive":true, "update":true, "delete":true}, "checkFileStability": true, "stabilityCheckInterval": 10, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "emailIDs":"test@gmail.com,infa@hotmail.com" "rules": [ { "id": 10070, "folderPath": "C:\\temp1", "patternType":"wildcard", "filePattern": "*.txt", "postAction": "NONE", "mandatory": false, "recursive": false } ], "scheduleDefinition": { "type": "DAILY_WITH_INTERVAL", "timezone": "IST", "startDate": "20181227", "endDate": "20181227", "runIndefinitely": false, "startsAt": "1015", "endsAt": "2355", "frequency": 15, "frequencyUnit": "SECONDS", "dayOfMonth": 0 }, "stopWhenRulesMet": false }
{ "id": "eX5qlosUfEHbwvNwGpRwQd", "name": "FL512087", "description": "Demo", "status": "ENABLE", "agentGroup": "01000025000000000002", "connection": { "type": "local", "name": "", "connId": "" }, "rules": [ { "id": 10070, "folderPath": "C:\\temp1", "filePattern": "*.txt", "patternType": "wildcard", "postAction": "NONE", "mandatory": false, "recursive": false } ], "scheduleDefinition": { "type": "DAILY_WITH_INTERVAL", "timezone": "IST", "startDate": "20181227", "endDate": "20181227", "runIndefinitely": false, "startsAt": "1015", "endsAt": "2355", "frequency": 15, "frequencyUnit": "SECONDS", "dayOfMonth": 0 }, "stopWhenRulesMet": false, "listenerEvents": { "arrive": true, "update": true, "delete": true }, "checkFileStability": true, "stabilityCheckInterval": 10, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "emailIDs":"test@gmail.com,infa@hotmail.com" "location": { "folderId": "avVCKODMM0RdSmcNWDnrKi", "folderName": "New", "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" } }
{ "responseCode": "NOT_FOUND", "message": "File Listener with id 'eX5qlosUfEHbwvNwGpRwQd1' not found." }