Zimbra REST API Reference:Get Item: Difference between revisions
No edit summary |
No edit summary |
||
Line 10: | Line 10: | ||
http://localhost:7070/home/john.doe/?id={item-id}&{params} | http://localhost:7070/home/john.doe/?id={item-id}&{params} | ||
</pre> | </pre> | ||
=== Item Id === | |||
Specifies the item id. | |||
=== Formats === | === Formats === | ||
<code> | <code>json,xml,tgz,zip</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | ||
{| | |||
|Item Type | |||
|Formats | |||
|- | |||
|Mail Message | |||
| | |||
|} | |||
Note: the ZIP format includes the contacts as individual vCard <code>.vcf</code> files | Note: the ZIP format includes the contacts as individual vCard <code>.vcf</code> files | ||
Revision as of 21:25, 16 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
Specifies the item id.
Formats
json,xml,tgz,zip
(Go to Response Formats)
Item Type | Formats |
Mail Message |
Note: the ZIP format includes the contacts as individual vCard .vcf
files
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Optional. The response format. Defaults tocsv
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