Product Documentation articleRetrieve a folder: lq851
Added by IBM contributorTao YT Yan | Edited by IBM contributorDana Liburdi on April 14, 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.
Tags: API

Overview

This is the specification for applications that retrieve Folder resources.

URL endpoints

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

URL
Description
/library/{library-id}/folder/{folder-id}/entry
Retrieve a folder given its id.


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.



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 for Lotus Quickr 8.5 for Domino


GET /dm/atom/library/_Papiplace1_RMain.nsf/folder/_Papiplace1_RMain.nsf_F71E3FD6E9A1BE5DD4825785500117B48/entry?acls=true HTTP/1.1
Host: example.com
User-Agent: Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; Trident/4.0)

Example Response for Lotus Quickr 8.5 for Domino


<?xml version="1.0" encoding="utf-8"?>
<entry xml:base="http://yantao-quickrd.cn.ibm.com/" xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td" xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
<id>urn:lsid:ibm.com:quickr:_Papiplace1_RMain_F71E3FD6E9A1BE5DD4825785500117B48</id>
<link href="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/entry" rel="self"/>
<link href="LotusQuickr/apiplace1/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/entry" rel="edit"/>
<category term="folder" scheme="tag:ibm.com,2006:td/type" label="folder"/>
<author>
<uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</uri>
<name>Susan Adams261</name>
<email></email>
</author>
<title type="text">folder 5</title>
<updated>2011-03-16T06:43:41Z</updated>
<published>2011-03-16T06:43:41Z</published>
<summary type="text">this is folder5</summary>
<td:created>2011-03-16T03:10:56Z</td:created>
<td:modified>2011-03-16T06:43:41Z</td:modified>
<td:type>simplelist</td:type>
<td:subtype></td:subtype>
<td:modifier>
<td:uri>uid=SusanAdams261%2Fou=Users%2Fl=Westford%2Fst=Massachusetts%2Fc=US%2Fou=Lotus%2Fo=Software%20group%2Fdc=ibm%2Fdc=com</td:uri>
<td:name>Susan Adams261</td:name>
<td:email></td:email>
</td:modifier>
<content type="application/atom+xml" src="dm/atom/library/_Papiplace1_RMain/folder/_Papiplace1_RMain_FG_2dXdJXhVEXtI/feed"/>
</entry>