Getting a feed of your filesAdded by IBM on June 26, 2012 | Version 1 (Original)
|Get a feed that lists the files in your library.
Get a feed that lists the files in your library.
Table 1. Atom API request details
|HTTP Method||Sample URL|
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
|acls||Specifies whether or not 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.|
|includePath||If set to true , an entry extension <td:path> that specifies the path to the object is returned in the resulting feed. This parameter takes a Boolean value of either true or false. By default, the path information is not returned.|
|includeQuota||If set to true , the <td:librarySize> and <td:libraryQuota> elements, which provide size and quota information, are returned in the resulting feed. This parameter takes a Boolean value of either true or false. By default, the quota information is not returned.|
|includeTags||Specifies whether or not the tags that are displayed on the welcome page are included in the returned Atom document. This parameter takes a Boolean value of either true or false. By default, the tags are not returned.|
|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 collection 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. |
|sI||Start index. Specifies the start index (number) in the collection from which the results should be returned. This parameter is ignored if a page parameter is provided.|
|since||Returns only those files that were added or last updated after the specified time. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time.|
|sortBy||String. Specifies what to sort the returned entries by. Options are:|
Sorts the entries by the number of comments or replies an item has received.created
Sorts the entries by the date the item was created.downloaded
Sorts the entries by the number of times the item was downloaded.length
Sorts the entries by the size of the file.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).recommended
Sorts the entries by the number of times the item was recommended.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 modified.
|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.
|tag||String. Filters the list of results by tag. To specify multiple tags, either separate the tag names with commas or provide the tag parameter multiple times. Providing more than one tag has the effect of an AND operator.|
|visibility||Defines who has access to the files. Options are: public or private. If you set this parameter equal to public, only public files are returned. If you set this parameter equal to private, only private files are returned.|