Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

Update a file listener

Update a file listener

Use a PUT request to update a file listener.

PUT Request

Use the following URI to update an existing file listener.
PUT <server URL>/mftsaas/api/v1/filelisteners/<filelistener ID>
Use the following fields in the PUT request:
Field
Type
Required
Description
id
String
Yes
ID number associated with the file listener.
name
String
Yes
Name of the file listener.
description
String
-
Description of the file listener.
status
String
Yes
Status of the file listener.
  • enabled
    . Listens to files on the designated folder.
  • disabled
    . Does not listen to files on the designated folder.
agentGroup
Numeric
Yes
Runtime environment that contains the Secure Agent used to run the file listener.
connectionType
String
Yes
Type of the connection to which the file listener listens.
connection
String
Yes
Connection to which the file listener listens.
folderPath
String
Yes
Path to the folder on the connection to which the file listener listens.
filePattern
String
Yes
File name pattern to which the file listener listens.
Post Action
String
-
Determines the action the file listener must perform after the file listener listens to the events.
You can select the post action as
Delete
only if the file pattern is an indicator file. Default is None.
The following connection types support the Post Action option:
  • Local folder
  • Advanced FTP V2
  • Advanced FTPS V2
  • Advanced SFTP V2
  • Azure Data Lake Store Gen2
patternType
String
Yes
The file pattern.
  • wildcard. Use wildcard patterns of file name.
  • regex. Use regular expression to match the file pattern. Consider the following examples:
    • Use the following syntax to listen to all files except for files with a name that contains out, foo, and baz:
      ^(?!.*(?:out|baz|foo)).*$ à all except
    • Use the following syntax to listen to all files with doc and docx, pdf extensions:
      ([a-zA-Z0-9\s_\\.\-\(\):])+(.doc|.docx|.pdf)$ à
mandatory
String
-
Defines whether rule values are mandatory.
recursive
String
-
Defines whether rule values are recursive.
scheduleDefinition
String
Yes
Defines the frequency in which the file listener must run.
type
String
Yes
Frequency at which the file listener runs, daily, weekly, or monthly.
timezone
String
Yes
Time zone that refers to the start and end time.
startDate
Date/Time
Yes
Date on which the file listener starts running.
endDate
Date/Time
Yes
Date until which the file listener runs.
runIndefinitely
String
-
The file listener runs without an end date.
startsAt
Date/Time
Yes
Time of day when the file listener starts running.
endsAt
Date/Time
Yes
Time of day when the file listener stops running.
frequency
Numeric
Yes
Frequency at which the file listener checks for files in the folder.
frequencyUnit
String
Yes
Unit of frequency to which file listener checks for files in the folder, by seconds, minutes, or hours.
listenerEvents
String
Yes
Determines when the file listener sends notifications to the services that are registered to it. Response to each event, when the event is set to true is as follows:
  • arrive. Send notifications when files arrive at the folder to which the file listener listens.
  • update. Send notifications when files in the folder to which the file listener listens, are updated.
  • delete. Send notifications when files in the folder to which the file listener listens are deleted.
stopWhenRulesMet
String
-
The file listener stops listening to the folder when the listener rules are met.
  • false
    . The file listener notifies the registered application on events and continues to listen for subsequent events.
  • true
    . The listener stops listening to the folder when the first event of file deletion occurs in the folder.
checkFileStability
String
-
The file listener verifies that the entire file is copied to the folder before notifying the registered services.
notifyExistingFiles
String
-
The first time the file listener runs, it sends a notification if files exist in the folder to which it listens.
excludeFileEventsWhenNotRunning
String
-
Determines if you want to exclude the file events that occur when a file listener is not running.
continueOnError
String
-
Determines if you want the file listener to continue to retry and run in case of a failure, such as temporary network disruption.
emailIds
String
-
List of email addresses to send notifications if the file listener fails.
Use commas to separate email addresses in the list.
location
String
-
Location of the project folder.

PUT request example

Use this sample as a reference to update the file listener.
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": false, "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 }

PUT response

If the request to update the file listener is successful, you receive the response similar to the following example:
{ "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": false, "notifyExistingFiles": false, "excludeFileEventsWhenNotRunning": true, "continueOnError": true, "emailIDs":"test@gmail.com,infa@hotmail.com" "location": { "folderId": "avVCKODMM0RdSmcNWDnrKi", "folderName": "New", "projectId": "3iWWHkLbM2giVppBmJmZgV", "projectName": "Default" } }
If the request to update the file listener is unsuccessful, you might receive an error similar to the following example:
{ "responseCode": "NOT_FOUND", "message": "File Listener with id 'eX5qlosUfEHbwvNwGpRwQd1' not found." }


Updated May 03, 2021