Zimbra REST API Reference:Get Briefcase: Difference between revisions
Malte Stretz (talk | contribs) No edit summary |
|||
(9 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | {{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{devel}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | |||
== REST API Method: Get Briefcase == | == REST API Method: Get Briefcase == | ||
Line 10: | Line 26: | ||
http://localhost:7070/home/john.doe/Briefcase?{params} | http://localhost:7070/home/john.doe/Briefcase?{params} | ||
</pre> | </pre> | ||
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | |||
=== HTTP Method === | === HTTP Method === | ||
Line 32: | Line 50: | ||
=== Usage Examples === | === Usage Examples === | ||
Retrieve a directory of the "Briefcase" folder (this will include a list of sub-folders and documents): | |||
<pre> | |||
http://localhost:7070/home/john.doe/Briefcase | |||
</pre> | |||
Retrieve the list of items in the "Briefcase" folder in JSON format: | Retrieve the list of items in the "Briefcase" folder in JSON format: | ||
Line 53: | Line 76: | ||
</pre> | </pre> | ||
Retrieve the user-defined folder "MyBriefcaseFolder", in JSON format: | Retrieve the user-defined briefcase folder "MyBriefcaseFolder", in JSON format: | ||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json | http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json | ||
</pre> | </pre> | ||
Retrieve the directory of a user-defined "TestFolder1" folder that is a sub-folder of "Briefcase": | |||
<pre> | |||
http://localhost:7070/home/john.doe/Briefcase/TestFolder1 | |||
</pre> | |||
{{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | |||
[[Category:REST]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:Developers]] |
Latest revision as of 17:26, 5 August 2014
Article Information |
---|
This article applies to the following ZCS versions. |
<< Back to Zimbra REST API Reference
REST API Method: Get Briefcase
Gets the list of items in the briefcase folder. The default folder is "Briefcase" but user-defined folders are also supported.
URL
http://localhost:7070/home/john.doe/Briefcase?{params}
Go to Command Format
HTTP Method
GET
Formats
xml,json,rss,zip,tar,tgz
(Go to Response Formats)
Note: When using the zip,tar,tgz
formats, the items in the briefcase folder are packaged in the archive.
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Required. The response format.
Usage Examples
Retrieve a directory of the "Briefcase" folder (this will include a list of sub-folders and documents):
http://localhost:7070/home/john.doe/Briefcase
Retrieve the list of items in the "Briefcase" folder in JSON format:
http://localhost:7070/home/john.doe/Briefcase?fmt=json
Retrieve the list of items in the "Briefcase" folder in XML format:
http://localhost:7070/home/john.doe/Briefcase?fmt=xml
Retrieve the list of items in the "Briefcase" folder in RSS format:
http://localhost:7070/home/john.doe/Briefcase?fmt=rss
Download all items in the "Briefcase" folder in a ZIP archive:
http://localhost:7070/home/john.doe/Briefcase?fmt=zip
Retrieve the user-defined briefcase folder "MyBriefcaseFolder", in JSON format:
http://localhost:7070/home/john.doe/MyBriefcaseFolder?fmt=json
Retrieve the directory of a user-defined "TestFolder1" folder that is a sub-folder of "Briefcase":
http://localhost:7070/home/john.doe/Briefcase/TestFolder1