GrooveFilesBase64.Read Operation
Applies to: SharePoint Workspace 2010 | Visual Studio 2008
In this article
HTTP Post URL
Input Message Header
Input Message Parameters
Output Message Header
Return Value
The Read operation reads the metadata describing the files and folders in the Files tool or in the targeted folder. The Read operation optionally reads all contained folders recursively.
HTTP Post URL
The HTTP Post URL targets a Files tool or a folder within the Files tool. The URI that targets the Files tool is provided by the GrooveTools.Read operation in the ToolData element. The URI that targets a folder 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
<Recursive />
Element |
Data type |
Description |
|---|---|---|
Recursive |
xs:boolean |
Specifies that all folders within the Files tool or within the targeted folder should be read recursively. This element is optional. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
<ReadResult>
<!-- Array of --> <FileDescriptor />
</ReadResult>
Element |
Data type |
Description |
|---|---|---|
ReadResult |
Array of FileDescriptor |
Describes the files and folders. |
Remarks
If you specify a nonrecursive read of the Files tool itself, it returns the root and the top-level files and folders that it contains. Furthermore, if the HTTP Post URL targets the root folder, the operation treats it as if it had targeted the Files tool itself. Consequently, if you target the root folder, it returns the file descriptors for itself and for the files and folders that it contains.
See Also
Reference
GrooveFilesBase64.ReadFile Operation