Product Documentation articleRetrieve all working drafts in a library: lq851
Added by IBM contributorRui BJ Yang | 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 lists of all working Draft resources contained by a Library.

URL endpoints

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

URL
Description
/library/{library-id}/view/WorkingDrafts/feed
Retrieve resources contained by a library 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 | totalMediaSize|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
sI
number (1, 5, 10, etc.)
Specifies the start index in the collection from which the results should be returned. Ignored if page is provided
includeLocked
boolean (true, false)
if true, adds an entry extension showing if document is locked
includeLockOwner boolean true, false) if true, adds an entry extension showing who holds the lock
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
UnsupportedOperation
Returned when the operation is not supported


Example Request



GET /dm/atom/library/_Pplace2_Rmain.nsf/view/WorkingDrafts/feed HTTP/1.1


Example Response



<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">Working Drafts</title>
  <updated>2011-04-02T06:23:37Z</updated>
  <author>
    <name>Testuser7</name>
    <uri>CN=Testuser7,o=Notesdev,c=US</uri>
    <email>Testuser7@us.ibm.com</email>
  </author>
  <id>urn:lsid:ibm:com:td:_Pplace2_Rmain_FD8D8869EA3CABE638525723E007BD700</id>
  <td:uuid>_Pplace2_Rmain_FD8D8869EA3CABE638525723E007BD700</td:uuid>
  <link href="dm/atom/library/_Pplace2_RMain/view/_Pplace2_Rmain_FD8D8869EA3CABE638525723E007BD700/feed" rel="self"/>
  <link href="LotusQuickr/place2/main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
  <generator uri="LotusQuickr/place2/main.nsf/h_Toc/?OpenDocument"  version="851002.003" >LotusQuickr</generator>
  <serverdate>2011-04-06T04:10:53Z</serverdate>
  <entry xmlns:td="urn:ibm.com/td">
    <id>urn:lsid:ibm:com:td:_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD</id>
    <td:uuid>_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD</td:uuid>
    <link href="dm/atom/library/_Pplace2_RMain/draftpage/_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD/entry" rel="self"/>
    <link href="LotusQuickr/place2/main.nsf/D8D8869EA3CABE638525723E007BD700/2D5BA73EB1B04ABB4825785A00104CCD/?OpenDocument" rel="alternate"/>
    <link href="dm/atom/library/_Pplace2_RMain/draftpage/_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD/feed" rel="current"/>
    <link href="dm/atom/library/_Pplace2_RMain/draftpage/_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD/entry" rel="edit"/>
    <content  type="application/atom+xml"  src="dm/atom/library/_Pplace2_RMain/draftpage/_Pplace2_Rmain_D2D5BA73EB1B04ABB4825785A00104CCD/feed" />
    <category  term="draftpage"  scheme="tag:ibm.com,2006:td/type"  label="draftpage" />
    <title type="text">mypage-draft</title>
    <summary type="text">
      <![CDATA[This is my page]]>
      </summary>
    <published>2011-03-21T02:58:08Z</published>
    <updated>2011-03-21T02:58:08Z</updated>
    <author>
      <name>Testuser7</name>
      <uri>CN=Testuser7/O=Notesdev/C=US</uri>
      <email>Testuser7@us.ibm.com</email>
    </author>
    <td:created>2011-03-18T08:15:57Z</td:created>
    <td:modified>2011-03-21T02:58:08Z</td:modified>
    <td:documenttype>30DF3123AEFAF358052567080016723D</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>
  <entry xmlns:td="urn:ibm.com/td">
    <id>urn:lsid:ibm:com:td:_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt</id>
    <td:uuid>_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt</td:uuid>
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/entry" rel="self"/>
    <link href="LotusQuickr/place2/main.nsf/D8D8869EA3CABE638525723E007BD700/2A046A9BFE3BEA514825785A00107BC1/?OpenDocument" rel="alternate"/>
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/feed" rel="current"/>
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/entry" rel="edit"/>
    <content  type="application/atom+xml"  src="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/feed" />
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/media" type="text/plain" title="upload 2 attach.txt" length="50" rel="edit-media"/>
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/media" type="text/plain" title="upload 2 attach.txt" length="50" rel="enclosure"/>
    <link href="dm/atom/library/_Pplace2_RMain/draft/_Pplace2_Rmain_D2A046A9BFE3BEA514825785A00107BC1_Aupload_202_20attach.txt/media" type="text/plain" title="upload 2 attach.txt" length="50" rel="attachment0"/>
    <category  term="draft"  scheme="tag:ibm.com,2006:td/type"  label="draft" />
    <title type="text">upload 2 attach</title>
    <summary type="text">
      <![CDATA[]]>
      </summary>
    <published>2011-03-14T05:25:50Z</published>
    <updated>2011-03-14T05:25:50Z</updated>
    <author>
      <name>Testuser7</name>
      <uri>CN=Testuser7/O=Notesdev/C=US</uri>
      <email>Testuser7@us.ibm.com</email>
    </author>
    <td:created>2011-03-14T05:25:50Z</td:created>
    <td:modified>2011-03-14T05:25:50Z</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>
  <link href="dm/atom/library/_Pplace2_RMain/view/_Pplace2_Rmain_FD8D8869EA3CABE638525723E007BD700/feed?pageSize=10" rel="first"/>
</feed>