Zimbra REST API Reference:Get Briefcase
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