REST APIリファレンス

前へ次へ

ファイルリスナの作成

POST要求を使用して、ファイルリスナとイベントリスナを作成します。

POST要求

次のURIを使用して、ファイルリスナとイベントリスナを作成します。

POST <serverUrl>/mftsaas/api/v1/filelisteners

POST要求で次のフィールドを使用します。

フィールド	タイプ	必須	説明
name	String	○	ファイルリスナの名前。
description	String	-	ファイルリスナの説明。
status	String	○	ファイルリスナのステータス。 enabled 。指定されたフォルダでファイルをリスニングしています。 disabled 。指定されたフォルダでファイルをリスニングしていません。
agentGroup	Numeric	○	ファイルリスナの実行に使用されるSecure Agentを含むランタイム環境。
connectionType	String	○	ファイルリスナがリスニングする接続のタイプ。
connection	String	○	ファイルリスナがリスニングする接続。
folderPath	String	○	ファイルリスナがリスニングする接続上にあるフォルダへのパス。
filePattern	String	○	ファイルリスナがリスニングするファイル名パターン。
アクション後	String	-	ファイルリスナがイベントをリスニングした後にファイルリスナが実行する必要のあるアクションを決定します。ファイルパターンがインジケータファイルである場合にのみ、アクション後に［削除］を選択することができます。デフォルトは［なし］です。次の接続タイプは、［アクション後］のオプションをサポートします。ローカルフォルダ Advanced FTP V2 Advanced FTPS V2 Advanced SFTP V2 Azure Data Lake Store Gen2
patternType	String	○	ファイルパターン。 wildcard。ファイル名のワイルドカードパターンを使用します。 regex。正規表現を使用してファイルパターンを照合します。以下に例を示します。次の構文を使用すると、名前にout、foo、bazを含むファイルを除くすべてのファイルをリスニングします。 ^(?!.(?:out\|baz\|foo)).$ à all except 次の構文を使用すると、拡張子がdoc、docx、pdfのすべてのファイルをリスニングします。 ([a-zA-Z0-9\s_\\.\-:])+(.doc\|.docx\|.pdf)$ à インジケータファイル。ファイルリスナがリスニングするファイル名を使用します。
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に設定した場合の応答は次のとおりです。 arrive。ファイルリスナがリスニングするフォルダにファイルが到着したときに通知を送信します。 update。ファイルリスナがリスニングするフォルダのファイルが更新されたときに通知を送信します。 delete。ファイルリスナがリスニングするフォルダのファイルが削除されたときに通知を送信します。
stopWhenRulesMet	String	-	ファイルリスナは、リスナルールに合致するとフォルダのリスニングを停止します。 false 。ファイルリスナは、登録済みのアプリケーションにイベントを通知して、後続イベントのリスニングを継続します。 true 。ファイルリスナは、フォルダで最初のファイル削除イベントが発生した時点でそのフォルダのリスニングを停止します。
checkFileStability	String	-	ファイルリスナは、登録済みのサービスに通知する前に、ファイル全体がフォルダにコピーされたかどうかを確認します。
stabilityCheckInterval	Time	-	ファイルリスナがファイルの安定性を確認するために待機する時間（秒単位）。 checkFileStabilityオプションが true に設定されている場合にのみ、stabilityCheckIntervalフィールドに値を指定できます。
notifyExistingFiles	String	-	ファイルリスナが初めて実行されたときにすでにリスニング対象フォルダにファイルがあった場合に通知を送信します。
excludeFileEventsWhenNotRunning	String	-	ファイルリスナが実行されていないときに発生するファイルイベントを除外するかどうかを決定します。
continueOnError	String	-	一時的なネットワークの中断などのエラーが発生した場合に、ファイルリスナを再試行して実行し続けるかどうかを決定します。
emailIds	String	-	ファイルリスナにエラーが発生した場合に通知を送信するための電子メールアドレスのリスト。リスト内の電子メールアドレスを区切るには、カンマを使用します。
location	String	-	ファイルリスナコンポーネントを含むプロジェクトフォルダの場所。

POST要求の例

ファイルリスナを作成する際にはこの例を参考にしてください。

POST <serverUrl>/mftsaas/api/v1/filelisteners
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{
    "name": "{{NEWFILELISTENER-NAME}}",
    "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

}

POST応答の例

POST要求が成功した場合、次の例のような応答を受信します。

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

POST要求の例

イベントリスナを作成する際にはこの例を参考にしてください。

POST <serverUrl>/public/core/v1/filelisteners
Content-Type: application/json
Accept:application/json
Content-Type:application/json
IDS-SESSION-ID:{{IDS-SESSION-ID}}
{
    "name": "{{NEWEVENTLISTENER-NAME}}",
    "description": "",
    "agentGroup": "01000025000000000003",
    "sourceType": "Server",
    "location": {
        "projectId": "1UNDIQkHQYKcNLPdxeR56p",
        "projectName": "overRide"
    },
   "eventProvider": "AS2",
    "eventType": "as2_message_receive_failed",
    "rules": [
        {
            "key": "event.userName",
            "value": "Suraj",
            "operator": "NONE",
            "type": "CONTAINS"
        },
        {
            "key": "event.fileName",
            "value": "Test",
            "operator": "AND",
            "type": "STRING_EQUALS"
        },
        {
            "key": "event.fileSize",
            "value": "89",
            "operator": "OR",
            "type": "INTEGER_EQUALS"
        }
    ]
}

POST応答の例

POST要求が成功した場合、次の例のような応答を受信します。

{
    "id": "f11rC9Kwa0UlOeg2TIjBks",
    "name": "EventFL684930",
    "description": "",
    "agentGroup": "01000025000000000003",
    "sourceType": "Server",
    "location": {
        "projectId": "1UNDIQkHQYKcNLPdxeR56p",
        "projectName": "overRide"
    },
    "createTime": "2020-04-06T05:25:55Z",
    "lastUpdatedTime": "2020-04-06T05:25:55Z",
    "eventProvider": "AS2",
    "eventType": "as2_message_receive_failed",
    "rules": [
        {
            "key": "event.userName",
            "value": "Suraj",
            "operator": "NONE",
            "type": "CONTAINS"
        },
        {
            "key": "event.fileName",
            "value": "Test",
            "operator": "AND",
            "type": "STRING_EQUALS"
        },
        {
            "key": "event.fileSize",
            "value": "89",
            "operator": "OR",
            "type": "INTEGER_EQUALS"
        }
    ]
}

filelisteners

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal