Zimbra REST API Reference:Get Briefcase

Revision as of 21:12, 14 April 2010 by Cfremon (talk | contribs) (Adding Article Infobox and category)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
Admin Article

Article Information

This article applies to the following ZCS versions.

ZCS 6.0 Article ZCS 6.0

<< 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


Verified Against: Zimbra Collaboration Suite 6.0 Date Created: 01/16/2010
Article ID: https://wiki.zimbra.com/index.php?title=Zimbra_REST_API_Reference:Get_Briefcase Date Modified: 2010-04-14



Try Zimbra

Try Zimbra Collaboration with a 60-day free trial.
Get it now »

Want to get involved?

You can contribute in the Community, Wiki, Code, or development of Zimlets.
Find out more. »

Looking for a Video?

Visit our YouTube channel to get the latest webinars, technology news, product overviews, and so much more.
Go to the YouTube channel »

Jump to: navigation, search