Server API - Update Watch Folder

Last Updated: Dec 16, 2014 03:23PM PST
Update an existing watch folder configuration. This updates basic watch folder configuration. To update
individual sources, destinations, or presets, update these with the services provided for that purpose.
Some fields are private and can only be updated by the server.

Base URI /api/watchfolders/{folderId}/
Protocol HTTP
HTTP Method PUT
Response Formats XML, JSON
Help URL /api/watchfolders/help/operations/UpdateWatchFolder

Common Parameters
Name Required Description
folderId Yes Unique ID of the watch folder to update.

Request Data Fields
Name Data Type Required Description
WatchFolderUpdateInfo 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
CurrentScanServerId Guid Private Set by squeeze server when a server scans a watch folder
CurrentScanStart DateTime Private Set by squeeze server when a server scans a watch folder
LastScanEnd DateTime Private Set by squeeze server when a server scans a watch folder
LastScanNewestFileTimeTicks Long Private Set by squeeze server when a server scans a watch folder
LastScanNumberJobsCreated Int Private Set by squeeze server when a server scans a watch folder
LastScanOldestFileTimeTicks Long Private Set by squeeze server when a server scans a watch folder
LastScanServerName String Private Set by squeeze server when a server scans a watch folder
LastScanStart DateTIme Private Set by squeeze server when a server scans a watch folder
Message String Private Set by squeeze server when a server scans a watch folder
WatchFolderId Guid No Unique ID for the watch folder, same as the folder ID on the request. May be omitted.

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

Example cURL call:
curl -H "Accept: application/xml" -H "x-Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type:
application/xml" -X PUT -d "
<WatchFolderUpdateInfo>
<DeepScan>false</DeepScan>
<Enabled>true</Enabled>
<Name>testWatchFolder</Name>
<QueueId>00000000-0000-0000-0000-000000000000</QueueId>
</WatchFolderUpdateInfo>" http://<host>/api/watchfolders/<WatchFolder_GUID>/
















 
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