Getting a feed of your foldersAdded by IBM | Edited by IBM on March 15, 2012 | Version 3 (Show 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
|/basic/api/collections/feed||A feed of all file folders that are visible to the authenticated user. 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.|
|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 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:|
Organize the entries by the number of files associated with it.published
Organize the entries by the folder creation 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 the folder as modified.The default value of this parameter is title.
|sortOrder||Defines the order in which to sort the results. Options are: |
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. |
|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.|