Getting a feed of the user's folders (My Folders)
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 file folders to which the user has access.

You can derive the URL from the service document. Use the web address specified in the href attribute of the <collection> element that contains the <title type="text">My Folders</title> element.


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/collections/feed You can derive the URL from the service document. Use the web address specified in the href attribute of the <collection> element that contains the <title type="text">My Folders</title> element.
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
access
enumerated Yes Filters the returns by the access role of the authenticated user. Options are:
editor
manager
You can use this parameter with an authenticated request only.
Authorized values:
  • editor
  • manager
creator
string Yes User ID. Specifies to return only file folders created by the user specified by the user ID.
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. 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.
shared
enumerated Yes Filters the list of results based on whether the folder is shared or not. Options are true, false, or null. Passing null returns all content, regardless of whether it is shared. If visibility is public, then this parameter is ignored.
Authorized values:
  • true
  • false
  • null
sharedWithMe
boolean Yes 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.
sortBy
enumerated Yes String. Specifies what to sort the returned entries by. Options are:
itemCount
Sorts the entries by the number of items associated with the item. In this case, it sorts the entries by the number of files associated with the folder.
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 title.
Authorized values:
  • itemCount
  • 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
title
string Yes String. Specifies the title of the folder to return.
visibility
enumerated Yes Filters the list of results based on the target of the share. Options are public, private, and null. The default is null, which returns both the public folders, and the private folders to which you have access.
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
401
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.