Get a feed of the files in a folder 

Get a feed that lists the files associated with a file folder.

Table 1. Atom API request details

Resource Description
/basic/api/collection/{collection-id}/feed A feed of all the files in the folder specified by collection ID. You must authenticate this request.


Note: {collection-id} is the value of the <td:uuid> element in the collection's Atom document.

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

Table 2. Input parameters

Parameter Description
added Long integer representing a timestamp. Returns all files that were added to the folder after the specified date and time.
addedBy User ID. String. Specifies to return only file folders created by the user specified by the user ID.
created Long integer representing a timestamp. Returns all files created after the specified date and time.
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.
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:
created

    Organize the entries by the file creation date.

modified

    Organize the entries by the file content modification date.

published

    Organize the entries by the file publish 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 file content or document metadata was modified.

The default value of this parameter is modified.

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.

tag String. Filters the returns by the specified tag. You can specify up to three tag parameters.


Parent topic

Getting Files feeds


June 27, 2011 11:21:00 AM
   

 

Jun 27, 2011 11:21:00 AM Replaced /folder/ with /collection/ in the URI. 1

});