API Documentation‎ > ‎Actions‎ > ‎Watchfolder‎ > ‎

Create


Description

 

Request Method    
POST

ActionUrl

/api/v1/watchfolder

Request Parameter

 Name Description Required Default
 folder the folder to be watched YES 
 filefilter File Wildcard filter to select specific files in the folder NO *
 subdirs subdirectories should also be searched NO false
 flow-uuid the flow uuid of the target formats YES 
 interval interval in Minutes how often the folder should be scanned NO 5
 start Timestamp in which timeframe the watching should start NO 0
 end Timestamp in which timeframe the watching should end NO 0 (infinite)

Response Elements

 NameDescription 
 response the Response Element
 uuid the uuid of the watchfolder created

Examples


Example Request

URL:
http://localhost:8080/api/v1/watchfolder

JSON Payload:
{
    "folder":"/media/video",
    "filefilter":"*.mkv",
    "subdirs":true,
    "flow-uuid":"f78f4560-48fc-11e1-a522-0023ae8ddf40",
    "interval":5,
    "start":1212122121,
    "end":13131331
}

Example Response
{
        "response" : {
                "status" : "ok",
                "message" : "",
                "requestID" : "98447a4c-4b42-11e1-a569-0023ae8ddf40"
        },
        "uuid" : "98447d3a-4b42-11e1-a6ae-0023ae8ddf40"
}

Related Operations


Comments