GrooveFilesBase64.Import Operation
The Import operation copies a file or folder from the Windows file system to a folder in a Files tool. Optionally copies all contained folders recursively.
HTTP Post URL
The HTTP Post URL targets the Files tool. This URI is provided by the GrooveTools.Read operation in the ToolData 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 />
<FileDescriptor />
<Recursive />
| Element | Data type | Description |
|---|---|---|
URI |
|
Specifies the file or folder in the Windows file system that is to be imported. The URI is used to find the file or folder on the file system, but is not used to specify the name that the imported file is given. |
FileDescriptor |
Specifies the location and name of the imported file or folder. The FolderID element specifies the folder in the Files tool where the imported file or folder is put. For files, the Name element determines both the name and file extension. For folders, the Name element determines the name. The DisplayName and the Type elements are ignored. The type is determined by the whether the URI parameter specifies a file or folder. |
|
Recursive |
|
This parameter is meaningful only if you are importing a folder. If the parameter is true, the specified folder and all files and folders that it contains are imported recursively. If false, only the specified folder and its top-level files are imported. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ImportResult />
| Element | Data type | Description |
|---|---|---|
ImportResult |
|
The URI of the file or folder that has been created in the Files tool. In the case of a recursive import, the folder is the root of the imported subtree. |
Remarks
Import does not overwrite files or folders in the Files tool. Any name conflicts are resolved by creating a unique name in the Files tool.