Server API - Get Watch Folders

Last Updated: Dec 16, 2014 03:23PM PST
Get a list of watch folders.
 
Base URI / /api/watchfolders
Protocol HTTP
HTTP Method GET
Response Formats XML, JSON
Help URL /api/watchfolders/help/operations/GetWatchFolders

Common Parameters
None

Request Data Fields
None

Response Data Fields
Name DataType Required Description
WatchFolderGetInfoList Element Yes Container for the set of watch folders (XML)
WatchFolderGetInfo Element No Container for an individual watch folder (XML)
DeepScan Boolean No Scan the watch folder and sub folders if true (default). If false, sub folders are not scanned.
Enabled Boolean Yes If true, the watch folder is available for server processing. If false, the watch folder will not be processed
Name String Yes Name given to the watch folder
QueueId Guid Yes Queue that jobs will be assigned to when created
CurrentScanServerId Guid No If supplied, the watch folder is
currently being scanned by the server indicated by the ID.
CurrentScanServerStart DateTime No If supplied, this is the time (GMT) that the current scan was started.
LastScanEnd DateTime No If supplied, this is the time (GMT) that the last scan completed.
LastScanNewestFileTimeTicks Long No Time in ticks of the newest file found n the last scan that found files
LastScanNumberJobsCreated Int No Number of jobs that were created the last time the folder was scanned and created jobs
LastScanOldestFileTimeTicks Long No Time in ticks of the oldest file found in the last scan that found files
LastScanServerName String No Name of the server that last scanned the watch folder
LastScanStart DateTime No If supplied, the time the last watch folder scan started.
Message String No Any additional information message generated by the server when scanning the watch folder.
WatchFolderId Guid Yes Unique ID for the watch folder
Created DateTime Yes Date and time the watch folder was created
JobMediaInfo Element Yes Container for the JobMediaInfo object. See JobMediaInfo. CompressionPreset, DestinationInfo, and SourceMedia. A watch folder must have at least one destination in the JobMediaInfo, only one SourceMedia, but CompressionPreset is optional if at least one preset is in the watch folder.

Example cURL call:
curl –H “Accept: application/xml” –H “x-Authorization: Basic YWRtaW46YWRtaW4=” –X Get
http://<host>/api/watchfolders/
squeezesupport@sorensonmedia.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete