REST API Reference

Back Next

Getting file listener details

Use the GET request to view file listeners details. You can view the details for a particular file listener or view details for all file listeners in your organization.

GET request

To view the details of a particular file listener, include the file listener ID in the following URI:

Get <serverUrl>/mftsaas/api/v1/filelisteners/<filelistener ID>

To view the details for all of the file listeners in the organization, omit the file listener ID.

GET response

A request for file listener details returns the following information:

Field	Type	Description
id	String	ID number associated with the file listener.
name	String	Name of the file listener.
description	String	Description of the file listener.
status	String	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	Runtime environment that contains the Secure Agent used to run the file listener.
type	String	Type of the connection to which the file listener listens.
connection	String	Connection to which the file listener listens.
folderPath	String	Path to the folder on the connection to which the file listener listens.
filePattern	String	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	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)$ à indicator file. Use the file name to which the file listener listens.
mandatory	String	Defines whether rule values are mandatory.
recursive	String	Defines whether rule values are recursive.
type	String	Frequency at which the file listener runs, daily, weekly, or monthly.
timezone	String	Time zone that refers to the start and end time.
startDate	Date/Time	Date on which the file listener starts running.
endDate	Date/Time	Date until which the file listener runs.
runIndefinitely	String	Whether the file listener runs without an end date.
startsAt	Date/Time	Time of day when the file listener starts running.
endsAt	Date/Time	Time of day when the file listener stops running.
frequency	Numeric	Frequency at which the file listener checks for files in the folder.
frequencyUnit	String	Unit of frequency to which file listener checks for files in the folder, by seconds, minutes, or hours.
listenerEvents	String	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	Whether the file listener stops listening to the folder when the listener rules are met. Set to one of the following values: false . The file listener notifies the registered application on events and continues to listen for subsequent events. true . The file listener stops listening to the folder when the first event of file deletion occurs in the folder.
checkFileStability	String	Enter one of the following values. false .The file listener does not verify whether the entire file is copied to the folder before notifying the registered services. true . The file listener verifies whether the entire file is copied to the folder before notifying the registered services. Default is true .
stabilityCheckInterval	Time	Time in seconds that a file listener waits to check for file stability. You can specify a value in the stabilityCheckInterval field only if the checkFileStability option is set to true .
notifyExistingFiles	String	The first time the file listener runs, it sends a notification if files exist in the folder to which it listens, of the parameter is set to true.
excludeFileEventsWhenNotRunning	String	Determines if you want to exclude 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 failures, such as temporary network disruption.
location	String	Location of the project folder that contains the file listener component.
createTime	Date/Time	Time when the component was created.
lastupdateTime	Date/Time	Time when the component was last updated.

GET response example for one file listener

If your request to view file listener details of the file listener with ID

eX5qlosUfEHbwvNwGpRwQd

is successful, you might receive a response similar to the following example:

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

Response example to view all file listeners

If your request to view file listener details is successful, you might receive a response similar to the following example:

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

If the request to view all file listeners is unsuccessful, you might receive a response similar to the following example:

File Listener not found (403 Forbidden)
{    "responseCode": "NOT_FOUND",    "message": "File Listener with id 'eX5qlosUfEHbwvNwGpRwQd1' not found." }

File listeners

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage