Get a feed of file shares

Home

Get a feed of file shares

Get a feed that lists the share entries. A share entry describes an instance in which access that has been given to a file. This returns a feed of shares to which the authenticated user has access.

Atom API request details

Resource Description
/basic/api/myshares/feed A feed of shares

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

Input parameters

Parameter Description
direction Specifies which shares to return. Options are:

inbound

Files shared with you.

outbound

Files you have shared.

includePath Specifies whether or not to return the <td:path> element that shows the path to the object. This parameter takes a boolean value of either true or false. By default, the path is not returned.
owner User ID of the person whose files you want to return. Specify null if you want to return all files no matter the owner.
page Page number. Specifies the page to be returned. The default value is 1.
pageSize Page size. Specifies the number of entries to be returned per page.
sharedBy String. User ID. Filter the list of results by the creator of the share. Passing null returns all shared regardless of the person who created it.
sharedWhat String. Uuid. Filter the list of results by the unique ID of the resource being shared. If direction=outbound is also specified, this parameter is ignored.
sharedWith Sting. User ID. Filter the list of results based on a person with whom the file has been shared. Passing a null value returns all shares regardless of the person it was shared with. If direction=inbound is also specified, this parameter is ignored. Does not support multivalue.
sharePermission Filters the list of results based on the permission level granted in the share. The options are Edit or View. Passing null returns all shares regardless of the permissions.
sI Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
tag String. Filters the list of results by tag. You can specify up to three keywords by default. To specify multiple tags, either separate the tag names with commas or provide the tag parameter multiple times. Providing more than one tag has the effect of an AND operator.
visibility Defines who has access to the files. Options are: public or private. If you set this parameter equal to
public

, only public files are returned. If you set this parameter equal to
private

, only private files are returned.

You can find out a person's user ID by retrieving the person's profile feed. See Searching Profiles for more information.

Example
To search for all of the files that you have shared with others, send the following HTTP request:
> GET /files/basic/api/myshares/feed?direction=outbound 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:17:23 GMT
< ETag: "myshares:modified=1247692643484:updated=1247692643484"
< Content-Language: en-US
< Set-Cookie: LtpaToken2=xxx
< Set-Cookie: LtpaToken=xxx
< Set-Cookie: JSESSIONID=xxx
< Transfer-Encoding: chunked
< Date: Wed, 15 Jul 2009 21:17:22 GMT
< Server: WebSphere Application Server/6.1
< Expires: Thu, 01 Dec 1994 16:00:00 GMT
< Cache-Control: private, must-revalidate, max-age=0, no-cache=set-cookie
The following content is returned by the server:
<feed xmlns="http://www.w3.org/2005/Atom">
  <generator version="2.5.0.0" uri="http://www.ibm.com/xmlns/prod/sn">
   Lotus Connections Files
  </generator> 
  <id>urn:lsid:ibm.com:td:myshares</id> 
  <title type="text">Shared by Ingrid Stillman</title> 
  <link href="http://enterprise.acme.com:9088/files/basic/api/myshares/feed" rel="self" /> 
  <author>
    <name>Ingrid Stillman</name> 
    <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
      5b788f40-7d67-102c-845c-e2ebc3ec5536
    </snx:userid> 
    <email>istillman@us.acme.com</email> 
  </author>
  <updated>2009-07-15T21:17:23.484Z</updated> 
  <opensearch:totalResults 
   xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">
     1
  </opensearch:totalResults> 
  <collection 
   xmlns="http://www.w3.org/2007/app" 
   href="http://enterprise.acme.com:9088/files/basic/api/myshares/feed">
    <title xmlns="http://www.w3.org/2005/Atom" type="text">myshares</title> 
  </collection>
  <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> 
    <category term="share" scheme="tag:ibm.com,2006:td/type" label="share" /> 
    <author>
      <name>Ingrid Stillman</name> 
      <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
        5b788f40-7d67-102c-845c-e2ebc3ec5536
      </snx:userid> 
      <email>istillman@us.acme.com</email> 
    </author>
    <title type="text">folder.gif shared by Ingrid Stillman</title> 
    <published>2009-07-15T21:13:33.140Z</published> 
    <updated>2009-07-15T21:13:33.140Z</updated> 
    <td:sharedWith xmlns:td="urn:ibm.com/td">
      <td:sharedWithCount>1</td:sharedWithCount> 
    </td:sharedWith>
    <link 
     href="http://enterprise.acme.com:9088/files/basic/api/library/4031b3d3-dfb3-4a38-ac74-1230ff1ad272/
      document/4c46657e-4c58-4a3a-9ab4-df0217361e4f/entry" 
     rel="related" /> 
    <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/media/folder.gif" 
     rel="enclosure" 
     type="image/gif" 
     
     hreflang="en" 
     length="887" /> 
    <td:documentOwner xmlns:td="urn:ibm.com/td">
      <name>Ingrid Stillman</name> 
      <snx:userid xmlns:snx="http://www.ibm.com/xmlns/prod/sn">
       5b788f40-7d67-102c-845c-e2ebc3ec5536
      </snx:userid> 
      <email>istillman@us.acme.com</email> 
    </td:documentOwner>
    <td:libraryId xmlns:td="urn:ibm.com/td">4031b3d3-dfb3-4a38-ac74-1230ff1ad272</td:libraryId> 
    <td:sharedWhat xmlns:td="urn:ibm.com/td">4c46657e-4c58-4a3a-9ab4-df0217361e4f</td:sharedWhat> 
    <td:sharedResourceType xmlns:td="urn:ibm.com/td">document</td:sharedResourceType> 
    <td:visibility xmlns:td="urn:ibm.com/td">public</td:visibility> 
    <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/hit">
       0
    </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/share">
       1
    </snx:rank> 
  </entry>
</feed>
Get Files feeds

Related reference

Searching Profiles

+
Search Tips | Advanced Search

Parameter	Description
direction	Specifies which shares to return. Options are: inbound Files shared with you. outbound Files you have shared.
includePath	Specifies whether or not to return the <td:path> element that shows the path to the object. This parameter takes a boolean value of either true or false. By default, the path is not returned.
owner	User ID of the person whose files you want to return. Specify null if you want to return all files no matter the owner.
page	Page number. Specifies the page to be returned. The default value is 1.
pageSize	Page size. Specifies the number of entries to be returned per page.
sharedBy	String. User ID. Filter the list of results by the creator of the share. Passing null returns all shared regardless of the person who created it.
sharedWhat	String. Uuid. Filter the list of results by the unique ID of the resource being shared. If direction=outbound is also specified, this parameter is ignored.
sharedWith	Sting. User ID. Filter the list of results based on a person with whom the file has been shared. Passing a null value returns all shares regardless of the person it was shared with. If direction=inbound is also specified, this parameter is ignored. Does not support multivalue.
sharePermission	Filters the list of results based on the permission level granted in the share. The options are Edit or View. Passing null returns all shares regardless of the permissions.
sI	Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.
tag	String. Filters the list of results by tag. You can specify up to three keywords by default. To specify multiple tags, either separate the tag names with commas or provide the tag parameter multiple times. Providing more than one tag has the effect of an AND operator.
visibility	Defines who has access to the files. Options are: public or private. If you set this parameter equal to public , only public files are returned. If you set this parameter equal to private , only private files are returned.