Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

目次

Search

  1. はじめに
  2. Informatica Intelligent Cloud Services REST API
  3. プラットフォームREST APIバージョン2リソース
  4. プラットフォームREST APIバージョン3リソース
  5. データ統合 REST API
  6. ファイル取り込みとレプリケーションREST API
  7. ストリーミング取り込みとレプリケーションREST API
  8. RunAJobユーティリティ
  9. ParamSetCliユーティリティ
  10. REST APIコード
  11. REST APIリソースクイックリファレンス

REST APIリファレンス

REST APIリファレンス

ファイルリスナの詳細の取得

ファイルリスナの詳細の取得

GET要求を使用してファイルリスナの詳細を表示します。特定のファイルリスナの詳細を表示することも、組織のすべてのファイルリスナの詳細を表示することもできます。

GET要求

特定のファイルリスナの詳細を表示するには、次のURIにファイルリスナIDを含めます。
Get <serverUrl>/mftsaas/api/v1/filelisteners/<filelistener ID>
組織のすべてのファイルリスナの詳細を表示するには、ファイルリスナIDを省略します。

GET応答

ファイルリスナの詳細を要求すると、次のような情報が返されます。
フィールド
タイプ
説明
id
String
ファイルリスナに関連付けられているID番号。
name
String
ファイルリスナの名前。
description
String
ファイルリスナの説明。
status
String
ファイルリスナのステータス。
  • enabled
    。指定されたフォルダでファイルをリスニングしています。
disabled
。指定されたフォルダでファイルをリスニングしていません。
agentGroup
Numeric
ファイルリスナの実行に使用されるSecure Agentを含むランタイム環境。
type
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
ルールの値が再帰的かどうかを定義します。
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
次のいずれかの値を入力します。
  • false
    。ファイルリスナは、登録済みのサービスに通知する前に、ファイル全体がフォルダにコピーされたかどうかを確認しません。
  • true
    。ファイルリスナは、登録済みのサービスに通知する前に、ファイル全体がフォルダにコピーされたかどうかを確認します。
デフォルトは
true
です。
stabilityCheckInterval
Time
ファイルリスナがファイルの安定性を確認するために待機する時間(秒単位)。
checkFileStabilityオプションが
true
に設定されている場合にのみ、stabilityCheckIntervalフィールドに値を指定できます。
notifyExistingFiles
String
ファイルリスナが初めて実行されたときにすでにリスニング対象フォルダにファイルがあった場合に通知を送信します。
excludeFileEventsWhenNotRunning
String
ファイルリスナが実行されていないときに発生するファイルイベントを除外するかどうかを決定します。
continueOnError
String
一時的なネットワークの中断などのエラーが発生した場合に、ファイルリスナを再試行して実行し続けるかどうかを決定します。
location
String
ファイルリスナコンポーネントを含むプロジェクトフォルダの場所。
createTime
Date/Time
コンポーネントが作成された時刻。
lastupdateTime
Date/Time
コンポーネントが最後に更新された時刻。

特定のファイルリスナのGET応答の例

IDが
eX5qlosUfEHbwvNwGpRwQd
のファイルリスナの詳細を表示するには、次の要求を使用します。
Get <serverUrl>/mftsaas/api/v1/filelisteners/<filelistener ID>
Content-Type: application/json Accept: application/json IDS-SESSION-ID:
eX5qlosUfEHbwvNwGpRwQd
要求が成功した場合、次の例のような応答が返されます。
{ "id": "eX5qlosUfEHbwvNwGpRwQd", "name": "FL512087", "description": "Demo", "status": "ENABLE", "agentGroup": "01000025000000000002", "connection": { "type": "local", "name": "", "connId": "" }, "rules": [ { "id": 10052, "folderPath": "C:\\temp1", "filePattern": "*.txt", "postAction": "NONE", "patternType": "wildcard", "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" }, "stopWhenRulesMet": false, "listenerEvents": { "arrive": true, "update": true, "delete": true }, "checkFileStability": true, "stabilityCheckInterval": 10, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "location": { "folderId": "avVCKODMM0RdSmcNWDnrKi", "folderName": "New", "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" }, "createTime": "2019-02-12T07:03:49Z", "lastUpdatedTime": "2019-02-12T07:03:49Z" }

すべてのファイルリスナを表示する応答の例

ファイルリスナの詳細を表示する要求が成功した場合、次の例のような応答を受け取ります。
{ "listeners": [ { "id": "8h9hng2kRokf2Db6Xb4pA8", "name": "dfgdfg", "description": "", "status": "ENABLE", "stopWhenRulesMet": false, "checkFileStability": false, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "location": { "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" }, "createTime": "2019-01-28T05:31:00Z", "lastUpdatedTime": "2019-01-28T05:31:00Z" }, { "id": "bQdKQmGlFUUgS85AevLkqi", "name": "FL123", "description": "xsdfsdfsdf", "status": "ENABLE", "stopWhenRulesMet": false, "checkFileStability": true, "stabilityCheckInterval": 10, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "location": { "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" }, "createTime": "2019-01-24T05:20:26Z", "lastUpdatedTime": "2019-01-25T06:52:40Z" }, { "id": "eX5qlosUfEHbwvNwGpRwQd", "name": "FL512087", "description": "Demo", "status": "ENABLE", "stopWhenRulesMet": false, "checkFileStability": true, "stabilityCheckInterval": 10, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "location": { "folderId": "avVCKODMM0RdSmcNWDnrKi", "folderName": "New", "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" }, "createTime": "2019-02-12T07:03:49Z", "lastUpdatedTime": "2019-02-12T07:03:49Z" } ] }
すべてのファイルリスナを表示する要求が失敗した場合、次の例のような応答を受け取ります。
File Listener not found (403 Forbidden) { "responseCode": "NOT_FOUND", "message": "File Listener with id 'eX5qlosUfEHbwvNwGpRwQd1' not found." }