Product Documentation articleRetrieve a document: lq851
Added by IBM contributorXiang Yu Hao | Edited by IBM contributorJames A Riel on April 15, 2011 | Version 2
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

Overview

This is the specification for applications that retrieve Document resources.

URL endpoints

Perform a GET operation on one of the following URL formats:

URL
Description
/library/{library-id}/document/{document-idOrLabel}/entry
Retrieve a document given its id or unique label.



Authentication

This method does not require authentication to retrieve public resources. If authentication is provided, the user must have 'View' authority on the specified resource.

Arguments



The following URL arguments are supported on this operation:
Argument
Example
Description
lock
boolean (true, false)
Retrieve a locked document if locked document for editing, if locking is required
acls
boolean (true, false)
Specifies if the authenticated users permissions are returned for each entry
includeDocumentType
boolean (true, false)
Specifies if the document type is returned
includePropertySheetType
boolean (true, false)
Specifies if the property sheet type(s) is returned
includePropertySheets
boolean (true, false)
Specifies if the property sheet field values are returned


Error Codes

Error Code
Description
Unknown
Returned when the cause of an error is unknown
AccessDenied
Returned when the cause of an error is due to a permission restriction
ItemNotFound
Returned when the cause of an error is related to a resource not being found
Unsupported Operation
Returned when the operation is not supported




Example Request



GET /dm/atom/library/_Pplace_RMain.nsf/page/_Pplace_RMain.nsf_D4E7C474A0FE616F1852576FC0051B3D7/entry


Example Response


The request to Retrieve a Page or a document is the same.


Response of retrieving a page





<entry xml:base="http://hao.cn.ibm.com/">
 <id>urn:lsid:ibm.com:quickr:_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC</id>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/page/_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC/entry" 
rel="self"/>
 <link href="http://hao.cn.ibm.com/LotusQuickr/place11/Main.nsf/h_Toc/C4D8651B0E1E26744825784C001E50AC?OpenDocument" rel="alternate"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/page/_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC/entry"
 rel="edit"/>
 <link href="dm/atom/library/_Pplace11_RMain/folder/_Pplace11_RMain_FCD0EF97D625305B90525670800167213/feed" rel="parent"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC_A2.odt/media/2.odt" 
rel="attachment0" title="2.odt" length="6009"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC_A1t.ods/media/1t.ods" 
rel="attachment1" title="1t.ods" length="5877"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/page/_Pplace11_RMain_DC4D8651B0E1E26744825784C001E50AC/feed" 
rel="enclosure" type="application/unknown" title="page1" hreflang="en" length="0"/>
 <category term="page" scheme="tag:ibm.com,2006:td/type" label="page"/>
 <td:responseCount>0</td:responseCount>
<author>
 <uri>CN=wpsadmin%2Fou=Users%2Fou=Westford%2Fou=Lotus%2Fo=Software%20Group%2Fdc=lotus%2Fdc=notesdev%2Fdc=ibm%2Fdc=com</uri>
 <name>wpsadmin</name>
 <email>wpsadmin@cn.ibm.com</email>
 </author>
<td:modifier>
 <td:uri>CN=wpsadmin%2Fou=Users%2Fou=Westford%2Fou=Lotus%2Fo=Software%20Group%2Fdc=lotus%2Fdc=notesdev%2Fdc=ibm%2Fdc=com</td:uri>
 <td:name>wpsadmin</td:name>
 <td:email>wpsadmin@cn.ibm.com</td:email>
 </td:modifier>
 <title type="text">page1</title>
 <updated>2011-03-07T05:31:07Z</updated>
 <published>2011-03-07T05:31:07Z</published>
 <summary type="html">&lt;p&gt; 111&lt;/p&gt;</summary>
 <td:created>2011-03-07T05:31:07Z</td:created>
 <td:modified>2011-03-07T05:31:07Z</td:modified>
 </entry>


Response of retrieving a document




<entry xml:base="http://hao.cn.ibm.com/">
 <id>urn:lsid:ibm.com:quickr:_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D</id>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D/entry" 
rel="self"/>
 <link href="http://hao.cn.ibm.com/LotusQuickr/place11/Main.nsf/h_Toc/A63E9A33FD03EEE34825784C000DC92D?OpenDocument" rel="alternate"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D/entry"
 rel="edit"/>
 <link href="dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain" rel="parent"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D_A2.odt/media/2.odt" 
rel="attachment0" title="2.odt" length="6009"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D/media"
 rel="edit-media"/>
 <link href="http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D/media"
 rel="enclosure" type="application/unknown" title="2.odt" hreflang="en" length="6009"/>
 <category term="document" scheme="tag:ibm.com,2006:td/type" label="document"/>
 <td:responseCount>0</td:responseCount>
<author>
 <uri>CN=wpsadmin%2Fou=Users%2Fou=Westford%2Fou=Lotus%2Fo=Software%20Group%2Fdc=lotus%2Fdc=notesdev%2Fdc=ibm%2Fdc=com</uri>
 <name>wpsadmin</name>
 <email>wpsadmin@cn.ibm.com</email>
 </author>
<td:modifier>
 <td:uri>CN=wpsadmin%2Fou=Users%2Fou=Westford%2Fou=Lotus%2Fo=Software%20Group%2Fdc=lotus%2Fdc=notesdev%2Fdc=ibm%2Fdc=com</td:uri>
 <td:name>wpsadmin</td:name>
 <td:email>wpsadmin@cn.ibm.com</td:email>
 </td:modifier>
 <title type="text">New Document1</title>
 <updated>2011-03-07T02:56:39Z</updated>
 <published>2011-03-07T02:30:34Z</published>
 <summary type="html">111</summary>
 <td:created>2011-03-07T02:30:34Z</td:created>
 <td:modified>2011-03-07T02:56:39Z</td:modified>
 <content type="application/unknown" xml:lang="en" src="
http://hao.cn.ibm.com/dm/atom/library/_Pplace11_RMain/document/_Pplace11_RMain_DA63E9A33FD03EEE34825784C000DC92D/media"/>
 </entry>



If acls is true, and are returned. Document roles are contributor or reader.