Getting a feed of your foldersAdded by IBM on June 26, 2012 | Version 1 (Original)
|Get a feed that lists file folders to which you have access.
Get a feed that lists file folders to which you have access.
Table 1. Atom API request details
|HTTP Method||Sample URL|
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.
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
Parent topic: Getting Files feeds
|access||Filters the returns by the access role of the authenticated user. Options are:
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.|
|page||Page number. Specifies the page to be returned. The default value is 1, which returns the first page.|
|ps||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||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. |
|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 a page parameter is provided.|
|sortBy||String. Specifies what to sort the returned entries by. Options are:|
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.
|sortOrder||Specifies the order in which to sort the results. The options are: |
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.
|title||String. Specifies the title of the folder to return. |
|visibility||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.|