Filters the returns by the access role of the authenticated user. Options are editor and manager. You can use this parameter with an authenticated request only.

creator

string

Yes

User ID. Specifies to return only file folders created by the user specified by the user ID.

format

enumerated

Yes

Specifies the format of the response. Options are atom or json. The default value is atom.

Authorized values:

atom

json

includeCount

boolean

Yes

Specifies whether the total number of pinned folders should be returned in the feed. The options are true and false. The default is true.

page

int

Yes

Page number. Specifies the page to be returned. The default value is 1, which returns the first page.

ps

int

Yes

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

enumerated

Yes

Filters the list of results based on whether the folder is shared. Options are true, false, or null. Passing null returns all content, regardless of whether it is shared. If the visibility parameter is public, then this parameter is ignored.

Authorized values:

true

false

null

sharedWithMe

boolean

Yes

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

int

Yes

Start index. Specifies the start index (number) in the folder from which the results should be returned. This parameter is ignored if the page parameter is provided.

sortBy

enumerated

Yes

String. Specifies what to sort the returned entries by. Options are:createdSorts the entries by the date the item was created.displayOrderSorts the entries in the order chosen by the user in the pinned views in the product user interface.modifiedSorts the entries by the last modified date.publishedSorts the entries by the date the item was published (usually related to atom:published element).titleSorts the entries alphabetically by title. The title used is the text that is displayed in the <title> element of each entry in the feed.updatedSorts the entries by the last time the item was updated.The default value of this parameter is displayOrder.

Authorized values:

created

displayOrder

modified

published

title

updated

sortOrder

enumerated

Yes

Specifies the order in which to sort the results. The options are:ascSorts the results in ascending order.descSorts 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.

Authorized values:

asc

desc

title

string

Yes

Specifies the title of the folder to return.

type

enumerated

Yes

Specifies the types of folders to return in the feed. The options are all, community, and personal. The default value is personal.

Authorized values:

all

community

personal

visibility

enumerated

Yes

Filters the list of results based on visibility flag. Options are public, private, and null. The default is null, which returns both the public folders, and the private folders that you have pinned.

The authentication mechanism selected by your application to access the API. Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services. See the reference topic "OAuth 2.0 APIs for web server flow" for more information.