Difference between revisions of "Zimbra REST API Reference:Get Item"

(Formats)
(Item Id)
Line 13: Line 13:
 
=== Item Id ===
 
=== Item Id ===
  
Specifies the item id.
+
<ul>
 +
<li><code>{item-id}</code>. Required. Specifies the item id.</li>
 +
</ul>
  
 
=== Formats ===
 
=== Formats ===

Revision as of 17:29, 17 January 2010

<< Back to Zimbra REST API Reference

REST API Method: Get Item

Gets an item.

URL

http://localhost:7070/home/john.doe/?id={item-id}&{params}

Item Id

  • {item-id}. Required. Specifies the item id.

Formats

Type Formats Default Format Comments
Mail Message json,xml,rss,atom,zip,tar,tgz Defaults to MIME. When using the zip,tar,tgz formats, the mail message is packaged in the archive as an <cod>eml</code> file (i.e. plain text in MIME format).
Appointment json,xml,ics Defaults to iCalendar format(.ics).  
Contact json,xml,vcf Defaults to vCard format (.vcf).  
Task json,xml,ics,rss,atom Defaults to iCalendar format(.ics).  

See Response Formats for more information.

Requires Authentication

true (Go to Authentication)

Parameters

  • id. Required. The item id.
  • fmt. Optional. The response format.
  • query. Optional. A query keyword.

Usage Examples

Download the contacts as a CSV file:

http://localhost:7070/home/john.doe/contacts
http://localhost:7070/home/john.doe/contacts?fmt=csv

Retrieve the contacts in XML format:

http://localhost:7070/home/john.doe/contacts?fmt=xml

Retrieve the contacts in JSON format:

http://localhost:7070/home/john.doe/contacts?fmt=json

Download the contacts as a ZIP file:

http://localhost:7070/home/john.doe/contacts?fmt=zip


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_Item Date Modified: 2010-01-17



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