Difference between revisions of "Zimbra REST API Reference:Get Item"
(→Formats) |
Malte Stretz (talk | contribs) |
||
(26 intermediate revisions by 4 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:Tab1|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | ||
+ | {{Template:Tab2|[[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 8.0}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | ||
== REST API Method: Get Item == | == REST API Method: Get Item == | ||
Line 10: | Line 26: | ||
http://localhost:7070/home/john.doe/?id={item-id}&{params} | http://localhost:7070/home/john.doe/?id={item-id}&{params} | ||
</pre> | </pre> | ||
+ | |||
+ | Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | ||
+ | |||
+ | === HTTP Method === | ||
+ | |||
+ | <code>GET</code> | ||
=== Item Id === | === Item Id === | ||
− | Specifies the item id. | + | <ul> |
+ | <li><code>id={item-id}</code>. Required. Specifies the item id to retrieve.</li> | ||
+ | </ul> | ||
=== Formats === | === Formats === | ||
Line 20: | Line 44: | ||
|style="background-color:#ffffcc;" width="15%"|'''Type''' | |style="background-color:#ffffcc;" width="15%"|'''Type''' | ||
|style="background-color:#ffffcc;" width="15%"|'''Formats''' | |style="background-color:#ffffcc;" width="15%"|'''Formats''' | ||
+ | |style="background-color:#ffffcc;" width="15%"|'''Default Format''' | ||
|style="background-color:#ffffcc;"|'''Comments''' | |style="background-color:#ffffcc;"|'''Comments''' | ||
|- | |- | ||
|Mail Message | |Mail Message | ||
− | |<code>json, xml, rss, atom, zip, tar, tgz</code> | + | |<code>json,xml,rss,atom,zip,tar,tgz,sync</code> |
− | Defaults to <code>MIME</code> | + | |Defaults to <code>MIME</code> (RFC822). |
− | |When using the <code>zip,tar,tgz</code> formats, the mail message is packaged in the archive as | + | |When using the <code>zip,tar,tgz</code> formats, the mail message is packaged in the archive as a <code>.eml</code> file (i.e. plain text in <code>MIME</code> RFC822 format). |
+ | |- | ||
+ | |Appointment | ||
+ | |<code>json,xml,ics</code> | ||
+ | |Defaults to iCalendar format(<code>.ics</code>). | ||
+ | | | ||
+ | |- | ||
+ | |Contact | ||
+ | |<code>json,xml,vcf</code> | ||
+ | |Defaults to vCard format (<code>.vcf</code>). | ||
+ | | | ||
+ | |- | ||
+ | |Task | ||
+ | |<code>json,xml,ics,rss,atom</code> | ||
+ | |Defaults to iCalendar format(<code>.ics</code>). | ||
+ | | | ||
|} | |} | ||
Line 37: | Line 77: | ||
<ul> | <ul> | ||
− | <li><code>fmt</code>. Optional. The response format. | + | <li><code>id</code>. Required. The message id.</li> |
− | <li><code> | + | <li><code>fmt</code>. Optional. The response format.</li> |
+ | </ul> | ||
+ | |||
+ | ==== Mail Message Parameters ==== | ||
+ | |||
+ | <ul> | ||
+ | <li><code>imap_id</code>. Optional. Specify an IMAP id in lieu of a message id.</li> | ||
+ | <li><code>part</code>. Optional. Specify which part of the MIME message to retrieve.</li> | ||
</ul> | </ul> | ||
=== Usage Examples === | === Usage Examples === | ||
− | + | Retrieve the mail message (with id 288) as MIME RFC822 format: | |
<pre> | <pre> | ||
− | http://localhost:7070/home/john.doe/ | + | http://localhost:7070/home/john.doe/?id=288 |
</pre> | </pre> | ||
+ | |||
+ | Download the mail message (with id 553) attachment (in part 2 of the message): | ||
<pre> | <pre> | ||
− | http://localhost:7070/home/john.doe/ | + | http://localhost:7070/home/john.doe/?id=288&part=2 |
</pre> | </pre> | ||
− | Retrieve the | + | Retrieve the contact (with id 272) in XML format: |
<pre> | <pre> | ||
− | http://localhost:7070/home/john.doe/ | + | http://localhost:7070/home/john.doe/?id=272&fmt=xml |
</pre> | </pre> | ||
− | Retrieve the | + | Retrieve the appointment (with id 506) in ICS format: |
<pre> | <pre> | ||
− | http://localhost:7070/home/john.doe/ | + | http://localhost:7070/home/john.doe/?id=506 |
</pre> | </pre> | ||
− | + | Retrieve the task (with id 582) in ICS format: | |
<pre> | <pre> | ||
− | http://localhost:7070/home/john.doe/ | + | http://localhost:7070/home/john.doe/?id=582 |
</pre> | </pre> | ||
− | {{Article Footer|Zimbra Collaboration | + | {{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} |
+ | [[Media:Example.ogg]] | ||
+ | |||
+ | |||
+ | [[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 Item
Gets an item.
URL
http://localhost:7070/home/john.doe/?id={item-id}&{params}
Go to Command Format
HTTP Method
GET
Item Id
id={item-id}
. Required. Specifies the item id to retrieve.
Formats
Type | Formats | Default Format | Comments |
Mail Message | json,xml,rss,atom,zip,tar,tgz,sync
|
Defaults to MIME (RFC822).
|
When using the zip,tar,tgz formats, the mail message is packaged in the archive as a .eml file (i.e. plain text in MIME RFC822 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 message id.fmt
. Optional. The response format.
Mail Message Parameters
imap_id
. Optional. Specify an IMAP id in lieu of a message id.part
. Optional. Specify which part of the MIME message to retrieve.
Usage Examples
Retrieve the mail message (with id 288) as MIME RFC822 format:
http://localhost:7070/home/john.doe/?id=288
Download the mail message (with id 553) attachment (in part 2 of the message):
http://localhost:7070/home/john.doe/?id=288&part=2
Retrieve the contact (with id 272) in XML format:
http://localhost:7070/home/john.doe/?id=272&fmt=xml
Retrieve the appointment (with id 506) in ICS format:
http://localhost:7070/home/john.doe/?id=506
Retrieve the task (with id 582) in ICS format:
http://localhost:7070/home/john.doe/?id=582