Product Documentation articleRetrieve a list of libraries: lq851
Added by IBM contributorRui BJ Yang | Edited by IBM contributorCraig Lordan on October 21, 2011 | Version 6
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 lists of Library resources.

URL endpoints

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

URL
Description
/libraries/feed
Retrieve a list of libraries



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)
value to sort the response
sO
string (asc, dsc)
Specifies the order of the sort as either ascending or descending
placeId string ID of the team place to list the component libraries from.



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/libraries/feed?placeId=_Pplace20_RMain.nsf HTTP/1.1

Example Response



<?xml version="1.0" encoding="utf-8" ?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:td="urn:ibm.com/td">
  <id>urn:lsid:ibm.com:td:_Pplace20_RMain</id>
  <author>
    <name>Testuser7</name>
    <uri></uri>
  </author>
  <generator uri="LotusQuickr//Main.nsf/h_Toc?OpenDatabase"  version="1.0" >LotusQuickr</generator>
  <link href="http://yr.cn.ibm.com/dm/atom/libraries/feed" rel="self" />
  <title type="text">Quickr Libraries</title>
  <updated>2011-03-23T06:02:25Z</updated>
  <entry xmlns:td="urn:ibm.com/td">
    <category  term="library"  scheme="tag:ibm.com,2006:td/type"  label="library" />
    <id>urn:lsid:ibm.com:td:_Pplace20_RMain</id>
    <published>2011-02-28T05:20:52Z</published>
    <title type="text">place20</title>
    <updated>2011-03-21T20:01:06Z</updated>
    <link href="http://yr.cn.ibm.com/dm/atom/library/%5B@Pplace20/@RMain.nsf%5D/entry" rel="self" />
    <link href="http://yr.cn.ibm.com/place20" rel="alternate" />
    <content  type="application/atom+xml"  src="http://yr.cn.ibm.com/dm/atom/library/%5B@Pplace20/@RMain.nsf%5D/feed" />
    <td:created>2011-02-28T05:20:52Z</td:created>
    <td:modified>2011-03-21T20:01:06Z</td:modified>
  </entry>
</feed>