Get a feed of public files

Home

Get a feed of public files

Get a feed that lists all files. This returns a feed of all public file. This resource does not accept authentication.

Atom API request details

Resource Description
/basic/anonymous/api/documents/feed?visibility=public A feed of all files.

Atom API request details
Resource	Description
/basic/anonymous/api/documents/feed?visibility=public	A feed of all files.

Use one or more of the input parameters to narrow the search. Separate multiple parameters with an ampersand (&).

Input parameters

Parameter Description
page Page number. Specifies the page to be returned assuming a constant page size. The default value is 1.
pageSize Page size. Specifies the number of items to include in a paged request. The default value is 10. Specify the page size in increments of ten.
sI Start index. Specifies the start index (as a number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
since Returns only those files that were last updated after the specified date. Specify the date using the ? format.
sortOrder String. Specifies what to sort the returned entries by. Options are:

commented

Organize the entries by the number of comments or replies that the file has received.

created

Organize the entries by file creation date.

downloaded

Organize the entries by the number of times the file has been downloaded.

recommended

Organize the entries by the number of times the file has been recommended.

The default option is created.
sortBy String. Defines the order in which to sort the results. Options are:

asc

Ascending.

desc

Descending. This value is the default value.

Defaults to desc when using the default sortOption of created. If you specify a different sortOption, this parameter defaults to asc.
tag String. Returns all files tagged with the specified keyword. You can specify up to three keywords by default. Separate multiple tag names with commas. The administrator can configure Files to allow for searching more or fewer tags.
visibility
This parameter is required.
Defines who has access to the files. Set this parameter equal to
public

, which specifies that you want to return all of the files that can be accessed by anyone who can log in to the Files feature.

Input parameters
Parameter	Description
page	Page number. Specifies the page to be returned assuming a constant page size. The default value is 1.
pageSize	Page size. Specifies the number of items to include in a paged request. The default value is 10. Specify the page size in increments of ten.
sI	Start index. Specifies the start index (as a number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
since	Returns only those files that were last updated after the specified date. Specify the date using the ? format.
sortOrder	String. Specifies what to sort the returned entries by. Options are: commented Organize the entries by the number of comments or replies that the file has received. created Organize the entries by file creation date. downloaded Organize the entries by the number of times the file has been downloaded. recommended Organize the entries by the number of times the file has been recommended. The default option is created.
sortBy	String. Defines the order in which to sort the results. Options are: asc Ascending. desc Descending. This value is the default value. Defaults to desc when using the default sortOption of created. If you specify a different sortOption, this parameter defaults to asc.
tag	String. Returns all files tagged with the specified keyword. You can specify up to three keywords by default. Separate multiple tag names with commas. The administrator can configure Files to allow for searching more or fewer tags.
visibility This parameter is required.	Defines who has access to the files. Set this parameter equal to public , which specifies that you want to return all of the files that can be accessed by anyone who can log in to the Files feature.

Example

To search for all public files, send the following HTTP request:

> GET /files/basic/anonymous/api/documents/feed?visibility=public HTTP/1.1
> Authorization: Basic ...
> Host: files.enterprise.acme.com:9088
> Accept: */*

The HTTP response would look as follows:

HTTP/1.1 200 OK
X-LConn-Auth: true Content-Type: application/atom+xml; charset=UTF-8 Last-Modified: Wed, 15 Jul 2009 21:18:13 GMT Content-Language: en-US Set-Cookie: JSESSIONID=xxx Transfer-Encoding: chunked Date: Wed, 15 Jul 2009 21:18:12 GMT Server: WebSphere Application Server/6.1 Expires: Thu, 01 Dec 1994 16:00:00 GMT Cache-Control: public, max-age=30, no-cache=set-cookie

The following content is returned by the server:

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:lsid:ibm.com:td:documents</id> 
  <link 
   href="http://enterprise.acme.com:9088/files/basic/anonymous/api/documents/feed" 
   rel="self" /> 
  <title type="text">Public Files</title> 
  <updated>2009-07-15T21:18:13.312Z</updated> 
  <generator version="2.5.0.0" uri="http://www.ibm.com/xmlns/prod/sn">
   Lotus Connections Files
  </generator> 
  <snx:rank 
   xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
   scheme="http://www.ibm.com/xmlns/prod/sn/item">
     2
  </snx:rank> 
  <opensearch:totalResults 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
     2
  </opensearch:totalResults> 
  <entry>
    <id>urn:lsid:ibm.com:td:4c46657e-4c58-4a3a-9ab4-df0217361e4f</id> 
    <td:uuid xmlns:td="urn:ibm.com/td">4c46657e-4c58-4a3a-9ab4-df0217361e4f</td:uuid> 
    <td:label xmlns:td="urn:ibm.com/td">folder.gif</td:label> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/entry" 
     rel="self" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/app/file/4c46657e-4c58-4a3a-9ab4-df0217361e4f" 
     rel="alternate" type="text/html" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/entry" 
     rel="edit" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/media" 
     rel="edit-media" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/media/folder.gif" 
     rel="enclosure" 
     type="image/gif" 
     
     hreflang="en" 
     length="887" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/media" 
     rel="qkr-media-anonymous" /> 
    <category term="document" scheme="tag:ibm.com,2006:td/type" label="document" /> 
    <link 
     href="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/feed" 
     rel="replies" 
     type="application/atom+xml" 
     xmlns:thr="http://purl.org/syndication/thread/1.0" 
     thr:count="0" /> 
    <author>
      <name>Jay Michaels</name> 
      <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
        5b788f40-7d67-102c-845c-e2ebc3ec5536
      </snx:userid> 
      <email>jmichaels@us.acme.com</email> 
    </author>
    <title type="text">folder.gif</title> 
    <published>2009-07-15T21:13:04.671Z</published> 
    <updated>2009-07-15T21:14:41.078Z</updated> 
    <td:created xmlns:td="urn:ibm.com/td">2009-07-15T21:13:04.671Z</td:created> 
    <td:modified xmlns:td="urn:ibm.com/td">2009-07-15T21:13:04.671Z</td:modified> 
    <td:lastAccessed xmlns:td="urn:ibm.com/td" /> 
    <td:modifier xmlns:td="urn:ibm.com/td">
      <name>Jay Michaels</name> 
      <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
       5b788f40-7d67-102c-845c-e2ebc3ec5536
      </snx:userid> 
      <email>jmichaels@us.acme.com</email> 
    </td:modifier>
    <td:visibility xmlns:td="urn:ibm.com/td">public</td:visibility> 
    <td:versionUuid xmlns:td="urn:ibm.com/td">bf8f77a5-0151-4b9a-b609-1ddf133f7a2b</td:versionUuid> 
    <td:versionLabel xmlns:td="urn:ibm.com/td">1</td:versionLabel> 
    <td:propagation xmlns:td="urn:ibm.com/td">true</td:propagation> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/recommendations">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/comment">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/hit">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/anonymous_hit">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/share">
       1
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/collections">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/attachments">
       0
    </snx:rank> 
    <snx:rank 
     xmlns:snx="http://www.ibm.com/xmlns/prod/sn" 
     scheme="http://www.ibm.com/xmlns/prod/sn/versions">
       1
    </snx:rank> 
    <td:totalMediaSize xmlns:td="urn:ibm.com/td">887</td:totalMediaSize> 
    <summary type="text" /> 
    <content 
     type="image/gif" 
     src="http://enterprise.acme.com:9088/files/basic/anonymous/api/library/
      4031b3d3-dfb3-4a38-ac74-1230ff1ad272/document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/media" /> 
  </entry>
</feed>

Get Files feeds