Get a feed of file shares 

Get a feed that lists the share entries. A share entry describes an instance in which access that has been given to a file.

This returns a feed of shares to which the authenticated user has access.

Table 1. Atom API request details

    Resource

    Description

    /basic/api/documents/shared/feed

    A feed of shares

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

Table 2. Input parameters

    Parameter

    Description

    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.

    direction

    Specifies which shares to return. Options are:
    inbound
    Files shared with you.
    outbound
    Files you have shared.

    The default value is inbound.

    includePath

    Specifies whether or not to return the <td:path> element that shows the path to the object. This parameter takes a Boolean value of either true or false. By default, the path is not returned.

    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. The default value is 10.

    sC

    Specifies which type of item to sort. Options are:
    document
    Represents a file.
    docShare
    Represents a share.
    The type you specify using this parameter affects the available options for the sortBy parameter.

    search

    String. Filter the list of results based on the specified string. 'acls', 'includePath', 'category', 'tag' parameters are ignored if this parameter is specified. This value is only supported when the direction parameter is not specified or equal to 'inbound'.

    sharedBy

    String. User ID. Filter the list of results by the creator of the share. Passing null returns all shared regardless of the person who created it.

    sharedWith

    Sting. User ID. Filter the list of results based on a person with whom the file has been shared. Passing a null value returns all shares regardless of the person it was shared with. If direction=inbound is also specified, this parameter is ignored. Does not support multivalue.

    sharePermission

    Filters the list of results based on the permission level granted in the share. The options are Edit or View. Passing null returns all shares regardless of the permissions.

    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 (when sC=docshare)

    String. Specifies what to sort the returned entries by. The options depend on the value you specify in the sC parameter.
    If sC=docshare, meaning you want to see file shares, the options are:
    author
    Organize the entries by the people who authored the shared files.
    created
    Organize the entries by the time the share was created.
    creator
    Organize the entries by the people who created the shares.
    published
    Organize the entries by the time the share was published.
    sharedBy
    Organize the entries by the people who shared a file.
    sharedWith
    Organize the entries by the people with whom the file was shared.
    The default value for shares is published.

    sortBy (when sC=document)

    String. Specifies what to sort the returned entries by. The options depend on the value you specify in the sC parameter.
    If sC=document, meaning you want to see files, the options are:
    commented: Sorts the entries by the number of comments or replies an item has received.
    created: Organize the entries by the time the file was created.
    downloaded: Sorts the entries by the number of times the item was downloaded.
    label: Sorts alphabetically by the label.
    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.
    totalMediaSize: Sorts the entries by the size of the media associated with the item.
    updated: Sorts the entries by the last time the item was updated.
    The default value for files 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 list of results by tag. You can specify up to three keywords by default. 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.




Note: You can find out a person's user ID by retrieving the person's profile feed. See Search Profiles for more information.


Parent topic

Getting Files feeds

November 9, 2011 11:54:02 AM
   

 

Nov 9, 2011 11:54:02 AM 13 Nov 8, 2011 4:35:24 PM 12 Nov 8, 2011 4:33:01 PM 11 Nov 8, 2011 1:50:58 PM Fixing content; accepting that formatting will be off. 11 Nov 8, 2011 1:50:58 PM Fixing content; accepting that formatting will be off. 10 Nov 8, 2011 1:40:03 PM Formatting 9 Nov 8, 2011 1:12:39 PM 8 Nov 8, 2011 1:11:33 PM 6 Nov 8, 2011 12:00:35 PM 5 Nov 8, 2011 12:00:00 PM 4 Nov 8, 2011 11:59:07 AM Trying to fix formatting. Cutting off text in a row. 3 Nov 8, 2011 11:30:41 AM 3 Nov 8, 2011 11:30:41 AM 2 Nov 8, 2011 9:51:09 AM 1

});