Server API - Create Watch Folder

Last Updated: Dec 16, 2014 03:24PM PST
Create a new watch folder configuration.
 
Base URI / /api/watchfolders
Protocol HTTP
HTTP Method POST
Response Formats XML, JSON
Help URL /api/watchfolders/help/operations/CreateWatchFolder


Common Parameters
None

Request Data Fields
Name DataType Required Description
WatchFolderCreateInfo Element Yes 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
JobMediaInfo Element Yes Container for presets, sources, and destinations associated with the job. See JobMediaInfo. A watch folder must have one SourceMedia, at least one DestinationInfo and at least one CompressionPreset of the preset is not in the watch folder itself.
    
 

Response Data Fields
Name DataType Required Description
WatchFolderGetInfo Element No Container for an individual watch folder
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 No Private-- supplied automatically
JobMediaInfo   Element Yes Container for presets, sources, and destinations associated with the job. See JobMediaInfo
 

Example cURL call:
curl -H "Accept: application/xml" -H "x-Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type:
application/xml" -X POST –d "
<WatchFolderCreateInfo>
<DeepScan>true</DeepScan>
<Enabled>false</Enabled>
<Name>My New Watch Folder</Name>
<QueueId>00000000-0000-0000-0000-000000000000</QueueId>
<JobMediaInfo>
<CompressionPresetList>
<CompressionPreset>
<PresetId>0ecdcbb9-a80e-4648-9467-c98c62787523</PresetId>
</CompressionPreset>
<CompressionPreset>
<UriLocation>file://C:/MyPresets/MP4_x264_512Kbps.spfx</UriLocation>
</CompressionPreset>
</CompressionPresetList>
<DestinationList>
<DestinationInfo>
<ExtensionNamingMethod>Default</ExtensionNamingMethod>
<FileNamingMethod>Default</FileNamingMethod>
<FileUri>file://C:/output/</FileUri>
</DestinationInfo>
</DestinationList>
<SourceMedia>
<FileUri>file://C:/source/</FileUri>
</SourceMedia>
</JobMediaInfo>
</WatchFolderCreateInfo>" http://localhost/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