GrooveFilesBase64.Export Operation
The Export operation copies a file or folder from a Files tool to the specified folder in the file system. Optionally copies all contained folders recursively.
HTTP Post URL
The HTTP Post URL targets a file or a folder within the Files tool. This URI is provided by the GrooveFilesBase64.Read operation and by other operations in the FileDescriptorURI element.
Input Message Header
GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.
Input Message Parameters
<URI />
<Recursive />
<OverwriteExisting />
| Element | Data type | Description |
|---|---|---|
URI |
|
Identifies the folder in the file system to which the file or folder is to be exported. |
Recursive |
|
This parameter is meaningful only if you are exporting a folder. If the parameter is true, the specified folder and all files and folders that it contains are exported recursively. If false, only the specified folder and its top-level files are exported. |
OverwriteExisting |
|
Specifies whether files should be overwritten and the folder specified in the URI should be created. If this parameter is true and the folder specified in the URI does not exist, the operation creates the folder before exporting the file or folders. If this parameter is false and the folder specified in the URI does not exist, then the operation fails. If this parameter is true and the folder specified in the URI does exist and contains files that will be overwritten by the export, then the operation overwrites the files. If this parameter is false and the folder specified in the URI exists and contains files that will be overwritten by the export, then the operation appends a number to the file names so that the new files have unique names. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
None.
Remarks
If you attempt to export any file that is not downloaded to the local system, the operation fails, no files or folders are created on the file system, and the operation returns a SOAP exception. To avoid this error, you should call the GrooveFilesBase64.Read operation and test that the FileDescriptorDownloadState element has a value of 1 for all files being exported. If necessary, you can call the GrooveFilesBase64.Download operation to download files.