Product Documentation articleRetrieve all checked out documents in a library: lq851
Added by IBM contributorTao YT Yan | Edited by IBM contributorDana Liburdi on April 18, 2011 | Version 3
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 lists of all checked out Document resources contained by a Library.

URL endpoints

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

URL
Description
/library/{library-id}/view/CheckedOut/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 | created | updated | published | modified }
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 http://example.com/dm/atom/library/_Papiplace2_RMain.nsf/view/CheckedOut/feed?pageSize=5&sI=2&sK=updated&sO=asc
Accept: */*
Accept-Language: en-us,ar-SA;q=0.7,zh-CN;q=0.3
x-requested-with: XMLHttpRequest
Content-Type: application/x-www-form-urlencoded
Accept-Encoding: gzip, deflate


Example Response



HTTP/1.1 200 OK
Server: Lotus-Domino
Content-Type: text/xml; charset=UTF-8
Content-Length: 13247
X-Server: Lotus Domino

<?xml version="1.0" encoding="utf-8" ?>
<feed 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">
<title type="text">Checked Out</title>
<updated>2011-04-06T02:14:07Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262,cn=Users,l=Westford,st=Massachusetts,c=US,ou=Lotus,o=Software%20group,dc=ibm,dc=com</uri>
<email>susanAdams262@cn.ibm.com</email>
</author>
<id>urn:lsid:ibm:com:td:_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700</id>
<td:uuid>_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/view/_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700/feed" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/h_Toc/?OpenDocument" rel="alternate"/>
<generator uri="LotusQuickr/apiplace2/Main.nsf/h_Toc/?OpenDocument"  version="852000.000" >LotusQuickr</generator>
<serverdate>2011-04-07T01:54:45Z</serverdate>
<entry xmlns:td="urn:ibm.com/td">
<id>urn:lsid:ibm:com:td:_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F</id>
<td:uuid>_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F/entry" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/D8D8869EA3CABE638525723E007BD700/448E37081D6B6EFE4825786A001BD20F?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F/feed" rel="current"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F/entry" rel="edit"/>
<content  type="application/atom+xml"  src="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F/feed" />
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_AExportToExcelService.java/media" title="ExportToExcelService.java" length="8349" rel="edit-media"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_AExportToExcelService.java/media" title="ExportToExcelService.java" length="8349" rel="enclosure"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_AExportToExcelService.java/media" title="ExportToExcelService.java" length="8349" rel="attachment0"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="edit-media"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="enclosure"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="attachment1"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="edit-media"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="enclosure"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_D448E37081D6B6EFE4825786A001BD20F_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="attachment2"/>
<category  term="draftpage"  scheme="tag:ibm.com,2006:td/type"  label="draftpage" />
<title type="text">page two with attachment</title>
<summary type="text"><![CDATA

have an attachment]></summary>

<published>2011-04-06T02:22:58Z</published>
<updated>2011-04-06T02:22:58Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=c
om</uri>
</author>
<td:created>2011-04-06T02:22:58Z</td:created>
<td:modified>2011-04-06T02:22:58Z</td:modified>
<td:documenttype>30DF3123AEFAF358052567080016723D</td:documenttype>
<td:modifier>
<td:name>Susan Adams262</td:name>
<td:uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</td:uri>
</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:_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls</id>
<td:uuid>_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/entry" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/D8D8869EA3CABE638525723E007BD700/06B9D7B4F7A982884825786A00119A15?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/feed" rel="current"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/entry" rel="edit"/>
<content  type="application/atom+xml"  src="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/feed" />
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="edit-media"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="enclosure"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D06B9D7B4F7A982884825786A00119A15_A6_20rows.xls/media" title="6 rows.xls" length="4608" rel="attachment0"/>
<category  term="draft"  scheme="tag:ibm.com,2006:td/type"  label="draft" />
<title type="text">6 rows</title>
<summary type="text"><![CDATA[]]></summary>
<published>2011-04-06T02:37:21Z</published>
<updated>2011-04-06T02:37:21Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
</author>
<td:created>2011-04-06T02:37:21Z</td:created>
<td:modified>2011-04-06T02:37:21Z</td:modified>
<td:documenttype>B3F12B7A9B7D48918525772A005313E3</td:documenttype>
<td:modifier>
<td:name>Susan Adams262</td:name>
<td:uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</td:uri>
</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:_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc</id>
<td:uuid>_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/entry" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/D8D8869EA3CABE638525723E007BD700/0BDDA35532FF9F094825786A00119BFE?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/feed" rel="current"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/entry" rel="edit"/>
<content  type="application/atom+xml"  src="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/feed" />
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="edit-media"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F09482578
6A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="enclosure"/>
<link href="dm/atom/library/_Papiplace2_RMain/draft/_Papiplace2_RMain_D0BDDA35532FF9F094825786A00119BFE_ACompleting_20single_20sign_2don_20setup.doc/media" title="Completing single sign-on setup.doc" length="139776" rel="attachment0"/>
<category  term="draft"  scheme="tag:ibm.com,2006:td/type"  label="draft" />
<title type="text">Completing single sign-on setup</title>
<summary type="text"><![CDATA[]]></summary>
<published>2011-04-06T02:41:20Z</published>
<updated>2011-04-06T02:41:20Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
</author>
<td:created>2011-04-06T02:41:20Z</td:created>
<td:modified>2011-04-06T02:41:20Z</td:modified>
<td:documenttype>94913AFBEAB46DA8052576A1006611BC</td:documenttype>
<td:modifier>
<td:name>Susan Adams262</td:name>
<td:uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</td:uri>
</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:_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B</id>
<td:uuid>_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B/entry" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/D8D8869EA3CABE638525723E007BD700/EC464BADFE9E370B4825786A001C146B?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B/feed" rel="current"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B/entry" rel="edit"/>
<content  type="application/atom+xml"  src="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DEC464BADFE9E370B4825786A001C146B/feed" />
<category  term="draftpage"  scheme="tag:ibm.com,2006:td/type"  label="draftpage" />
<title type="text">page 1</title>
<summary type="text"><![CDATA[]]></summary>
<published>2011-04-06T04:57:06Z</published>
<updated>2011-04-06T04:57:06Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
</author>
<td:created>2011-04-06T04:57:06Z</td:created>
<td:modified>2011-04-06T04:57:06Z</td:modified>
<td:documenttype>30DF3123AEFAF358052567080016723D</td:documenttype>
<td:modifier>
<td:name>Susan Adams262</td:name>
<td:uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</td:uri>
</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:_Papiplace2_RMain_DB791DE3C348369084825786A001C1659</id>
<td:uuid>_Papiplace2_RMain_DB791DE3C348369084825786A001C1659</td:uuid>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DB791DE3C348369084825786A001C1659/entry" rel="self"/>
<link href="LotusQuickr/apiplace2/Main.nsf/D8D8869EA3CABE638525723E007BD700/B791DE3C348369084825786A001C1659?OpenDocument" rel="alternate"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DB791DE3C348369084825786A001C1659/feed" rel="current"/>
<link href="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DB791DE3C348369084825786A001C1659/entry" rel="edit"/>
<content  type="application/atom+xml"  src="dm/atom/library/_Papiplace2_RMain/draftpage/_Papiplace2_RMain_DB791DE3C348369084825786A001C1659/feed" />
<category  term="draftpage"  scheme="tag:ibm.com,2006:td/type"  label="draftpage" />
<title type="text">page 2</title>
<summary type="text"><![CDATA[]]></summary>
<published>2011-04-06T04:57:21Z</published>
<updated>2011-04-06T04:57:21Z</updated>
<author>
<name>Susan Adams262</name>
<uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</uri>
</author>
<td:created>2011-04-06T04:57:21Z</td:created>
<td:modified>2011-04-06T04:57:21Z</td:modified>
<td:documenttype>30DF3123AEFAF358052567080016723D</td:documenttype>
<td:modifier>
<td:name>Susan Adams262</td:name>
<td:uri>uid=SusanAdams262/ou=Users/l=Westford/st=Massachusetts/c=US/ou=Lotus/o=Software group/dc=ibm/dc=com</td:uri>
</td:modifier>
<td:responseCount>0</td:responseCount>
<td:depth>0</td:depth>
</entry>
<td:totalNumber>14</td:totalNumber>
<link href="dm/atom/library/_Papiplace2_RMain/view/_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700/feed?pageSize=5" rel="first"/>
<link href="dm/atom/library/_Papiplace2_RMain/view/_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700/feed?pageSize=5&amp;pageKey=N00000000000D000000070000" rel="next"/>
<link href="dm/atom/library/_Papiplace2_RMain/view/_Papiplace2_RMain_FD8D8869EA3CABE638525723E007BD700/feed?pageSize=5&amp;pageKey=P00000000000D000000010000" rel="previous"/>
</feed>