Get a feed of your pinned folders 

Get a feed that lists file folders that you have pinned.

Table 1. Atom API request details

Resource Description
/basic/api/myfavorites/collections/feed A feed of all file folders that the authenticated user has pinned. You must authenticate this request.

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

Table 2. Input parameters

Parameter Description
access Filters the returns by the access role of the authenticated user. Options are editor and manager. You can use this parameter with an authenticated request only.
creator User ID. Specifies to return only file folders created by the user specified by the user ID.
format String. Specifies the format of the response. Options are atom or json. The default value is atom.
includeCount Specifies whether the total number of pinned folders should be returned in the feed. The options are true and false. The default is true.
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.
shared Filters the list of results based on whether the folder is shared. Options are true, false, or null. Passing null returns all content, regardless of whether it is shared.  If the visibility parameter is public, then this parameter is ignored.
sharedWithMe Filters the list of results based on whether the authenticated user was added to the folder and assigned to a specific role, and did not create the folder. Options are true or false. Defaults to false.
sI Start index. 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.
sortBy String. Specifies what to sort the returned entries by. Options are:
created

    Organize the entries by folder creation date.

displayOrder
modified

    Organize the entries by the file modification date.

published

    Organize the entries by the folder publication date.

title

    Organize the entries by title. The title is specified in the <title> element of the entry.

updated

    Organize the entries by last time that the folder was updated.

The default value of this parameter is displayOrder.

sortOrder Defines the order in which to sort the results. Options are:
asc

    Ascending

desc

    Descending

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.

title String. Specifies the title of the folder to return.
type String. Specifies the types of folders to return in the feed. The options are all, community, and personal. The default value is personal.
visibility Filters the list of results based on visibility flag. Options are public, private, and null. The default is null, which returns both the public folders, and the private folders that you have pinned.

Request header:

> GET /files/basic/api/myfavorites/collections/feed HTTP/1.1
> Authorization: Basic xxx
> Host: enterprise.example.com
> Accept: */*

Request response:

< HTTP/1.1 200 OK
...
< Content-Type: application/atom+xml; charset=UTF-8
< Content-Language: en-US

Returned feed:

<feed>
  <id>urn:lsid:ibm.com:td:collections</id>
  <link href="https://enterprise.example.com/files/basic/api/myfavorites/collections/feed" rel="self"/>
  <link href="https://enterprise.example.com/files/app/folders/pinned" rel="alternate"/>
  <title type="text">Pinned Folders 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-30T19:45:32.282Z</updated>
  <generator version="3.0.0.0" uri="http://www.ibm.com/xmlns/prod/sn">IBM Connections - Files</generator>
  <opensearch:totalResults>1</opensearch:totalResults>
  <entry>
    <id>
      urn:lsid:ibm.com:td:131b3547-a428-463c-b12c-4a67e8db04ff
    </id>
    <td:uuid>131b3547-a428-463c-b12c-4a67e8db04ff</td:uuid>
    <td:label>Sales</td:label>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/item">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/user">0</snx:rank>
    <snx:rank scheme="http://www.ibm.com/xmlns/prod/sn/group">0</snx:rank>
    <link 
     href="https://enterprise.example.com/files/basic/api/collection/131b3547-a428-463c-b12c-4a67e8db04ff/entry" 
     rel="self"/>
    <link 
     href="https://enterprise.example.com/files/app/folder/131b3547-a428-463c-b12c-4a67e8db04ff/" 
     rel="alternate" type="text/html"/>
    <link 
     href="https://enterprise.example.com/files/basic/api/collection/131b3547-a428-463c-b12c-4a67e8db04ff/entry" 
     rel="edit"/>
    <category term="collection" scheme="tag:ibm.com,2006:td/type" label="collection"/>
    <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>
    <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>
    <title type="text">Sales</title>
    <published>2010-07-30T19:43:49.915Z</published>
    <updated>2010-07-30T19:43:49.985Z</updated>
    <td:created>2010-07-30T19:43:49.915Z</td:created>
    <td:modified>2010-07-30T19:43:49.915Z</td:modified>
    <summary type="text"/>
    <td:visibility>private</td:visibility>
    <td:type>personal</td:type>
    <content 
     type="application/atom+xml" 
     src="https://enterprise.example.com/files/basic/api/collection/131b3547-a428-463c-b12c-4a67e8db04ff/feed"/>
  </entry>
</feed>


Parent topic

Getting Files feeds


   

 

});