Server API - Get Watch Folder Sources

Last Updated: Dec 16, 2014 03:24PM PST
Returns a list of the sources locations for a watch folder. A watch folder can have only one source location.
This service will return at most a list of one, but exists to keep REST URIs consistent and to allow for more
than one source in the future.

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

Common Parameters
Name Required Description
folderId Yes Unique ID for the watch folder

Request Data Fields
None

Response Data Fields
Name Data Type Required Description
SourceMediaInfoList Element Yes Contains one SourceMediaInfo element (XML). A watch folder can have only one source
SourceMediaInfo Element Yes Element contains data describing a job source or a watch folder source location
Created DateTime Private Date and time (GMT) that the source record was created
CredentialId Guid No Optional ID of a stored credential set to use to access the source.
FileName String No The file name will be treated as a folder if it ends with a slash (/) for watch folders
FileSize Long No Not used with watch folders
FileUri String No File Uri is the fully specified URI to the source file or location. Supported sources are ftp://, sftp://, s3://, azureblob://, and file://
JobId Guid Private Not used with watch folders
Modified DateTime Private Date and time the source has been modified, if any
Password String No Password to access secure source if the
CredentialId is not used
S3BucketName String Obsolete Name of the S3 bucket with the source. Required if the type is S3
SourceId Guid Private Unique ID for the source record
Type Enumeration Obsolete Type of source. The source can be: 0: Undefined – Not Set 1: Uri – Source is defined by a URI 2: S3 – Source is on Amazon S3
UserName String No Username for accessing a secured source location or file and when not using CredentialId
WatchFolderId Guid Private Unique ID of the watch folder this source is attached to

Example cURL call:
curl -H "Accept: application/xml" -H "x-Authorization: Basic YWRtaW46YWRtaW4=" -X DELETE -d ""
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