Getting a feed of your pinned files
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 30, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a feed that lists the files that you have pinned.

Request parameters

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

Input
Method URI Description
GET /files/{auth}/api/myfavorites/documents/feed Get a feed that lists the files that you have pinned.
Name Type Optional Description
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
acls
boolean Yes Specifies whether the permissions for each user should be displayed for each entry in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the permission information is not returned.
fileType
string Yes String. Filters the entries returned to include only those having the specified file extension.
format
enumerated Yes Specifies the format of the response. Options are atom, json, and json:id. The default value is atom.
Authorized values:
  • atom
  • json
  • json:id
includeCount
boolean Yes Specifies whether the total number of pinned files should be returned in the feed. The options are true and false. The default is true.
page
int Yes Page number. Specifies the page to be returned. The default value is 1, which returns the first page.
ps
int Yes Page size. Specifies the number of entries to return per page. The default value is 10. Specify the value in increments of 10. The maximum value you can specify is 500.
Note: This parameter replaces the pageSize parameter. The pageSize parameter is supported for backwards compatibility only; it will be deprecated in a future release.
sI
int Yes Specifies the start index (number) in the folder from which the results should be returned. This parameter is ignored if the page parameter is provided.
since
number Yes Returns only those files that were added or last updated after the specified time. Specify the time in the number of milliseconds since 1 January 1970, 00:00:00 GMT.
sortBy
enumerated Yes Specifies what to sort the returned entries by. Options are:
created
Sorts the entries by the date the item was created.
displayOrder
Sorts the entries in the order chosen by the user in the pinned views in the product user interface.
itemCount
Sorts the entries by the number of items associated with the item.
modified
Sorts the entries by the last modified date.
published
Sorts the entries by the date the item was published (usually related to atom:published element).
title
Sorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.
updated
Sorts the entries by the last time the item was updated.
The default value of this parameter is displayOrder.
Authorized values:
  • created
  • displayOrder
  • itemCount
  • modified
  • published
  • title
  • updated
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
Sorts the results in ascending order.
desc
Sorts the results in descending order.
If a value is specified for the sortBy parameter, but none is specified for this parameter, then this parameter defaults to asc. If neither is specified, this parameter defaults to desc.
Authorized values:
  • asc
  • desc
tags
string Yes String. Returns all files tagged with the specified string. You can specify up to three tags by default. Separate multiple tags with commas. The administrator can configure Files to allow for searching more or fewer tags.
title
string Yes String. Specifies the title of the folder to return.
visibility
enumerated Yes Filters the list of results based on visibility flag. Options are public, private, and null. The default is null, which returns both the public files, and the private files that you have pinned.
Authorized values:
  • public
  • private
  • null
Name Type Optional Description
Authorization
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • bearer
  • basic
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
401
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.
Examples
> GET /files/basic/api/myfavorites/documents/feed HTTP/1.1

> Authorization: Basic xxx

> Host: enterprise.example.com

> Accept: */*


Response returned by the server
< HTTP/1.1 200 OK

...

< Content-Type: application/atom+xml; charset=UTF-8

< Content-Language: en-US


<feed>

  <generator version="3.0.0.0" uri="http://www.ibm.com/xmlns/prod/sn">IBM Connections - Files</generator>

  <id>urn:lsid:ibm.com:td:myfavoritedocuments</id>

  <link href="https://enterprise.example.com/files/basic/api/myfavorites/documents/feed" rel="self"/>

  <link href="https://enterprise.example.com/files/app/pinnedfiles/" rel="alternate" type="text/html"/>

  <title type="text">Pinned Files Feed</title>

  <author>

    <name>Lyla Mahler</name>

    <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

    <email>lylamah@example.com</email>

    <snx:userState>active</snx:userState>

  </author>

  <updated>2010-07-30T20:10:28.282Z</updated>

  <opensearch:totalResults>2</opensearch:totalResults>

  <app:collection href="https://enterprise.example.com/files/basic/api/myfavorites/documents/feed">

    <title type="text">Pinned Files Feed</title>

    <app:accept>application/*</app:accept>

    <app:accept>image/*</app:accept>

    <app:accept>*/*</app:accept>

  </app:collection>

  <entry>

    <id>

      urn:lsid:ibm.com:td:6e82e55e-715b-4269-ac8a-c68a80c83427

    </id>

    <td:uuid>6e82e55e-715b-4269-ac8a-c68a80c83427</td:uuid>

    <td:label>image1.bmp</td:label>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/entry" 

     rel="self"/>

    <link 

     href="https://enterprise.example.com/files/app/file/6e82e55e-715b-4269-ac8a-c68a80c83427" 

     rel="alternate" 

     type="text/html"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/entry" 

     rel="edit"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/media" 

     rel="edit-media"/>

    <link 

     href="https://enterprise.example.com/files/basic/anonymous/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/media/image1.bmp" 

     rel="enclosure" 

     type="image/bmp" 

     title="image1.bmp" 

     hreflang="en" 

     length="0"/>

    <category term="document" scheme="tag:ibm.com,2006:td/type" label="document"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/feed" 

     rel="replies" 

     type="application/atom+xml" 

     thr:count="0"/>

    <author>

      <name>Lyla Mahler</name>

      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

      <email>lylamah@example.com</email>

      <snx:userState>active</snx:userState>

    </author>

    <title type="text">image1.bmp</title>

    <published>2010-07-14T18:38:23.897Z</published>

    <updated>2010-07-14T18:38:23.982Z</updated>

    <td:created>2010-07-14T18:38:23.897Z</td:created>

    <td:modified>2010-07-14T18:38:23.897Z</td:modified>

    <td:lastAccessed/>

    <td:modifier>

      <name>Lyla Mahler</name>

      <snx:userid>50730340-0101-102e-88e1-f78755f7e0ed</snx:userid>

      <email>lylamah@example.com</email>

      <snx:userState>active</snx:userState>

    </td:modifier>

    <td:visibility>public</td:visibility>

    <td:libraryId>9f9d6aad-4a05-4da5-9387-c95a00abf153</td:libraryId>

    <td:libraryType>personalFiles</td:libraryType>

    <td:versionUuid>bc35ebbf-2b2e-4737-bb90-2020a69c6232</td:versionUuid>

    <td:versionLabel>1</td:versionLabel>

    <td:propagation>true</td:propagation>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/recommendations">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/comment">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/share">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/collections">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/attachments">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/versions">1</snx:rank>

    <td:totalMediaSize>0</td:totalMediaSize>

    <summary type="text"/>

    <content 

     type="image/bmp" 

     src="https://enterprise.example.com/files/basic/api/library/9f9d6aad-4a05-4da5-9387-c95a00abf153/

      document/6e82e55e-715b-4269-ac8a-c68a80c83427/media"/>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/hit">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/anonymous_hit">0</snx:rank>

    <td:restrictedVisibility>false</td:restrictedVisibility>

    <td:objectTypeId>snx:file</td:objectTypeId>

  </entry>

  <entry>

    <id>

      urn:lsid:ibm.com:td:e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a

    </id>

    <td:uuid>e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a</td:uuid>

    <td:label>Sample Personal Home Page 0628160800.htm</td:label>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/entry" 

     rel="self"/>

    <link 

     href="https://enterprise.example.com/files/app/file/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a" 

     rel="alternate" 

     type="text/html"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/entry" 

     rel="edit"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/media" 

     rel="edit-media"/>

    <link 

     href="https://enterprise.example.com/files/basic/anonymous/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/media/Sample%20Personal%20Home%20Page%200628160800.htm" 

     rel="enclosure" 

     type="text/html" 

     title="Sample Personal Home Page 0628160800.htm" 

     hreflang="en" 

     length="5712"/>

    <category term="document" scheme="tag:ibm.com,2006:td/type" label="document"/>

    <link 

     href="https://enterprise.example.com/files/basic/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/feed" 

     rel="replies" 

     type="application/atom+xml" 

     thr:count="0"/>

    <author>

      <name>David Jones</name>

      <snx:userid>4fda6cc0-0101-102e-88df-f78755f7e0ed</snx:userid>

      <email>djones@example.com</email>

      <snx:userState>active</snx:userState>

    </author>

    <title type="text">Sample Personal Home Page 0628160800.htm</title>

    <published>2010-06-28T20:09:00.282Z</published>

    <updated>2010-06-28T20:11:03.611Z</updated>

    <td:created>2010-06-28T20:09:00.282Z</td:created>

    <td:modified>2010-06-28T20:09:00.282Z</td:modified>

    <td:lastAccessed/>

    <td:modifier>

      <name>David Jones</name>

      <snx:userid>4fda6cc0-0101-102e-88df-f78755f7e0ed</snx:userid>

      <email>djones@example.com</email>

      <snx:userState>active</snx:userState>

    </td:modifier>

    <td:visibility>shared</td:visibility>

    <td:libraryId>2009697b-5d58-4a0f-9ce0-db539225146b</td:libraryId>

    <td:libraryType>personalFiles</td:libraryType>

    <td:versionUuid>a5f035e3-63b2-4a00-b349-431e0c813448</td:versionUuid>

    <td:versionLabel>1</td:versionLabel>

    <td:propagation>true</td:propagation>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/recommendations">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/comment">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/share">1</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/collections">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/attachments">0</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/versions">1</snx:rank>

    <td:totalMediaSize>5712</td:totalMediaSize>

    <summary type="text"/>

    <content 

     type="text/html" 

     src="https://enterprise.example.com/files/basic/api/library/2009697b-5d58-4a0f-9ce0-db539225146b/

      document/e47bd54e-2f09-4d2d-84a8-6cbcb13bf50a/media"/>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/hit">1</snx:rank>

    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/anonymous_hit">0</snx:rank>

    <td:restrictedVisibility>false</td:restrictedVisibility>

    <td:objectTypeId>snx:file</td:objectTypeId>

  </entry>

</feed>