Skip to main content link. Accesskey S
  • Log In
  • Help
  • IBM Logo
  • Lotus Quickr wiki
  • All Wikis
  • All Forums
  • Home
  • Product Documentation
  • Community Articles
  • Learning Center
  • IBM Redbooks
Community Articles Product Documentation Learning Center IBM Redbooks This category Lotus Quickr 8.5 for WebSphere Portal Documentation Lotus Quickr 8.5.1 for Domino Documentation Lotus Quickr Connectors 8.5 Documentation Custom Search Scope...
Search
  • New Article
  • Share Show Menu▼
  • Subscribe Show Menu▼

About the Original Author

IBM contributorRui BJ Yang
Contribution Summary:
  • Articles authored: 15
  • Articles edited: 0
  • Comments Posted: 0

Recent articles by this author

Get place statistics: lq851
Overview Retrieve the latest place statistics data. URL endpoint Perform a GET operation on the following URL: URL Description myqcsrestplace{placeidentry Get place statistics data Authentication This method requires authentication. Only administrator and place owner can ...

Get system statistics: lq851
Overview Get the latest or specified period available system statistics data URL endpoint Perform a GET operation on the following URL: URL Descritpion myqcsreststatisticsfeed Get system statistics data. Authentication This method requires authentication. Only administrator ...

Permission: lq851
Overview Many operations in the API require the user to have an entitlement for accessing or modifying content in the system. These entitlements are expressed as a set of generic permissions on each resource. Permission Rights The following permission rights are defined: Permission ...

API conventions: lq851
p The IBM Lotus Quickr strongDocumentsstrong interfaces allow you to access and update the same information you can access and update in the Quickr web and connector user interfaces. The application programming interfaces (APIs) are access over HTTP so they can work over your network from ...

Operation tunneling: lq851
Overview When PUT and DELETE requests cannot be made directly, they can be tunneled via POST requests. This implementation looks for a special header XMethodOverride to identify the intended operation in a POST request. Below is an example of a PUT request that is tunneled via a POST ...

Community articleTechnical Preview: Retrieve a list of content in folder

Added by IBM contributor Rui BJ Yang | Edited by IBM contributor Rui BJ Yang on March 29, 2011 | Version 18
expanded Abstract
collapsed Abstract
No abstract provided.
Tags: Folder API, Quickr Domino8.5
ShowTable of Contents
HideTable of Contents
  • 1 Overview
  • 2 URL endpoints
  • 3 Authentication
  • 4 Arguments
  • 5 Error Codes
  • 6 Example Request
  • 7 Example Response

Overview

This is the specification for applications that retrieve lists of resources contained by a Folder.

URL endpoints

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

URL
Description
/library/{library-id}/folder/{folder-id}/feed
Retrieve resources contained by 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.

Arguments

The following URL arguments are supported on this operation. The default value for any argument is marked as bold in the table below.

Argument
Values
Description
pagesize
number (10,20, etc.)
Specifies number of items to include in a paged request
page
number (1, 2, 3, etc.)
Specifies page to be retrieved assuming constant page size
sK
string (title, created, updated, published, modified, desc, downloaded)
value to sort the response
sO
string (asc, dsc)
Specifies the order of the sort as either ascending or descending
acls
boolean (true, false)
Specifies if the authenticated user's permissions are returned for each library
category
string (folder, document, draft)
comma-delimited list of resource types to include in the response.


If callers specify a category filter of type draft, all other filter types are ignored and only content of type draft is 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
UnsupportedOperation
Returned when the operation is not supported
ColNotSortableReturned when the default sort column is no longer sortable


Example Request



The request is to get a folder with acl feed in which there is one folder with acl and one document.

GET dm/atom/library/%5B@Pplace2/@RMain.nsf%5D/folder/%5B@Pplace2/@RMain.nsf/@Fh_4EC8CD8D315A961E48257853002BB7C5%5D/feed?acls=true&psmd=48257855002A8359&noAuthHeader=true HTTP/1.1


Example Response



The response is returned with two entries.

<?xml version="1.0" encoding="utf-8" ?>
<feed xml:base="http://yr.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">
  <title type="text">folder1</title>
  <updated>2011-03-16T07:44:37Z</updated>
  <created>2011-03-14T07:57:30Z</created>
  <author>
    <name>Testuser7</name>
    <uri>CN=Testuser7%2FO=Notesdev%2FC=US</uri>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <id>urn:lsid:ibm:com:td:_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5</id>
  <td:uuid>_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5</td:uuid>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/feed" rel="self"/>
  <link href="LotusQuickr/place2/Main.nsf/h_Toc/C225E6D43B70759D48257853002BB7B5?OpenDocument" rel="alternate"/>
  <generator uri="LotusQuickr/place2/Main.nsf/h_Toc/C225E6D43B70759D48257853002BB7B5?OpenDocument"  version="851003.002">LotusQuickr</generator>
  <serverdate>2011-03-16T07:52:43Z</serverdate>
  <td:psmd newdata="1">48257855002A8A32</td:psmd>
  <entry xmlns:td="urn:ibm.com/td">
    <id>urn:lsid:ibm:com:td:_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED</id>
    <td:uuid>_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED</td:uuid>
    <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED/entry" rel="self"/>
    <link href="LotusQuickr/place2/Main.nsf/h_Toc/77FCB4C1FED653C748257855002A80D6?OpenDocument" rel="alternate"/>
    <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED/feed" rel="current"/>
    <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED/entry" rel="edit"/>
    <content type="application/atom+xml" src="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_FBF096C7BE65127CE48257855002A80ED/feed" />
    <link href="dm/atom/library/_Pplace2_RMain.nsf/view/_Pplace2_RMain.nsf_F4EC8CD8D315A961E48257853002BB7C5/feed" rel="parent"/>
    <td:type>simplelist</td:type>
    <category  term="folder"  scheme="tag:ibm.com,2006:td/type"  label="folder" />
    <title type="text">folder with acl</title>
    <summary type="text">
      <![CDATA[]]>
      </summary>
    <published>2011-03-16T07:44:38Z</published>
    <updated>2011-03-16T07:44:38Z</updated>
    <author>
      <name>Testuser7</name>
      <uri>CN=Testuser7/O=Notesdev/C=US</uri>
      <email>Testuser7@us.ibm.com</email>
    </author>
    <td:created>2011-03-16T07:44:14Z</td:created>
    <td:modified>2011-03-16T07:44:38Z</td:modified>
    <td:documenttype>1</td:documenttype>
    <td:modifier>
      <td:name>Testuser7</td:name>
      <td:uri>CN=Testuser7/O=Notesdev/C=US</td:uri>
      <td:email>Testuser7@us.ibm.com</td:email>
    </td:modifier>
    <td:depth>0</td:depth>
  </entry>
  <entry xmlns:td="urn:ibm.com/td">
    <id>urn:lsid:ibm:com:td:_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt</id>
    <td:uuid>_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt</td:uuid>
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/entry" rel="self"/>
    <link href="LotusQuickr/place2/Main.nsf/4EC8CD8D315A961E48257853002BB7C5/460616A85D04A06C48257855002A5984/?OpenDocument" rel="alternate"/>
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/feed" rel="current"/>
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/entry" rel="edit"/>
    <content  type="application/atom+xml" src="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/feed" />
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/media" type="text/plain" title="upload 1 attach.txt" length="50" rel="edit-media"/>
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/media" type="text/plain" title="upload 1 attach.txt" length="50" rel="enclosure"/>
    <link href="dm/atom/library/_Pplace2_RMain/document/_Pplace2_RMain_D460616A85D04A06C48257855002A5984_Aupload_201_20attach.txt/media" type="text/plain" title="upload 1 attach.txt" length="50" rel="attachment0"/>
    <category  term="document"  scheme="tag:ibm.com,2006:td/type"  label="document" />
    <title type="text">upload 1 attach</title>
    <summary type="text">
      <![CDATA[]]>
      </summary>
    <published>2011-03-16T07:42:34Z</published>
    <updated>2011-03-16T07:42:34Z</updated>
    <author>
      <name>Testuser7</name>
      <uri>CN=Testuser7/O=Notesdev/C=US</uri>
      <email>Testuser7@us.ibm.com</email>
    </author>
    <td:created>2011-03-16T07:42:34Z</td:created>
    <td:modified>2011-03-16T07:42:34Z</td:modified>
    <td:documenttype>94913AFBEAB46DA8052576A1006611BC</td:documenttype>
    <td:modifier>
      <td:name>Testuser7</td:name>
      <td:uri>CN=Testuser7/O=Notesdev/C=US</td:uri>
      <td:email>Testuser7@us.ibm.com</td:email>
    </td:modifier>
    <td:responseCount>0</td:responseCount>
    <td:depth>0</td:depth>
  </entry>
  <td:totalNumber>2</td:totalNumber>
  <td:acls inherit="false">
    <td:manager></td:manager>
    <td:contributor>
      <td:person>
        <uri>CN=domino testuser10/O=notesdev/C=US</uri>
        <td:dn>CN=domino testuser10,O=notesdev,C=US</td:dn>
        <name>domino testuser10</name>
      </td:person>
      <td:person>
        <uri>CN=domino testuser9/O=notesdev/C=US</uri>
        <td:dn>CN=domino testuser9,O=notesdev,C=US</td:dn>
        <name>domino testuser9</name>
      </td:person>
    </td:contributor>
    <td:reader></td:reader>
  </td:acls>
  <td:role>manager</td:role>
  <td:permissions>AddChild,AddFolder,Delete,EditProperties,Edit,View,GrantAccess,GrantAccessView,GrantAccessEdit</td:permissions>
  <link href="dm/atom/library/_Pplace2_RMain/folder/_Pplace2_RMain_F4EC8CD8D315A961E48257853002BB7C5/feed?pageSize=10" rel="first"/>
</feed>
expanded Attachments (0)
collapsed Attachments (0)
expanded Versions (26)
collapsed Versions (26)
Version Comparison     
VersionDateChanged by              Summary of changes
26Oct 21, 2011 4:26:50 PMCraig Lordan  IBM contributor
25Oct 20, 2011 10:01:37 PMRui BJ Yang  IBM contributor
24Oct 20, 2011 9:57:38 PMRui BJ Yang  IBM contributor
23Aug 21, 2011 10:54:07 PMRui Yang  IBM contributor
20Apr 6, 2011 12:05:07 AMRui BJ Yang  IBM contributor
19Mar 29, 2011 3:08:56 AMRui BJ Yang  IBM contributor
19Mar 30, 2011 11:13:08 PMRui BJ Yang  IBM contributor
This version (18)Mar 29, 2011 3:03:45 AMRui BJ Yang  IBM contributor
17Mar 22, 2011 9:32:17 PMXiang Yu Hao  IBM contributor
16Mar 22, 2011 2:42:52 AMRui BJ Yang  IBM contributor
15Mar 22, 2011 2:41:20 AMRui BJ Yang  IBM contributor
14Mar 22, 2011 2:40:15 AMRui BJ Yang  IBM contributor
13Mar 22, 2011 2:28:02 AMRui BJ Yang  IBM contributor
12Mar 22, 2011 1:47:21 AMRui BJ Yang  IBM contributor
11Mar 22, 2011 1:34:36 AMTao YT Yan  IBM contributor
10Mar 21, 2011 1:28:02 AMRui BJ Yang  IBM contributor
9Mar 20, 2011 11:40:23 PMRui BJ Yang  IBM contributor
8Mar 20, 2011 11:11:18 PMRui BJ Yang  IBM contributor
6Mar 20, 2011 11:04:00 PMRui BJ Yang  IBM contributor
5Mar 18, 2011 5:23:20 AMRui BJ Yang  IBM contributor
4Mar 18, 2011 5:18:12 AMRui BJ Yang  IBM contributor
3Mar 18, 2011 1:40:24 AMRui BJ Yang  IBM contributor
3Apr 18, 2011 2:24:46 PMDana Liburdi  IBM contributor
2Mar 18, 2011 1:35:45 AMRui BJ Yang  IBM contributor
2Mar 18, 2011 1:27:12 AMRui BJ Yang  IBM contributor
1Mar 18, 2011 1:22:58 AMRui BJ Yang  IBM contributor
Copy and paste this wiki markup to link to this article from another article in this wiki.
Go ElsewhereStay ConnectedHelpAbout
  • IBM Collaboration Solutions wikis
  • IBM developerWorks
  • IBM Software support
  • Twitter LinkIBMSocialBizUX on Twitter
  • FacebookIBMSocialBizUX on Facebook
  • ForumsLotus product forums
  • BlogsIBM Social Business UX Blog
  • Community LinkIBM Collaboration Solutions
  • Wiki Help
  • Forgot user name/password
  • Wiki design feedback
  • Content feedback
  • About the wiki
  • About IBM
  • Privacy
  • Accessibility
  • IBM Terms of use
  • Wiki terms of use