Getting a feed of the user's files (My Files)
Added by IBM contributorIBM | Edited by IBM contributorElizabeth Bowling on November 9, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a feed that lists the files in the user's library (My Files).

Request parameters

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

Notices

There is a complex interaction between visibility and shared query parameters.

When passing a sort order (sortBy) the order defaults to ascending, while natural ordering is by descending modified date.

The API may ignore misspelled or invalid parameter in the query.

 

Authentication

This method does not require authentication to retrieve public resources. If authentication is provided, the user must have 'View' authority on the specified resource.

Input
Method URI Description
GET /files/{auth}/api/myuserlibrary/feed Get a feed that lists the files in your library.
Name Type Optional Description
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
Name Type Optional Description
includePath
boolean Yes 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
boolean Yes 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
boolean Yes Specifies whether or not the tags that are displayed on the file 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. Tags appears as label attribute in the <category> element of each entry.
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 file has been shared or not. This parameter is mandatory if visibility is set to private, ignored otherwise. Options are true, false. When not specified he API returns all files, whether or not they have been shared; this is the default behavior when visibility is not private.
Authorized values:
  • true
  • false
sl
int Yes 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
number Yes Returns entries that have file content that has been added or updated since the specified time. Specify the time in the number of milliseconds since January 1, 1970, 00:00:00 GMT time.
sortBy
enumerated Yes String. Specifies what to sort the returned entries by. Options are:
commented
Sorts the entries by the number of comments or replies an item has received.
downloaded
Sorts the entries by the number of times the item was downloaded.
length
Organize 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.
Authorized values:
  • commented
  • downloaded
  • length
  • modified
  • published
  • recommended
  • title
  • updated
sortOrder
enumerated Yes Specifies the order in which to sort the results. The options are:
asc
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.
Authorized values:
  • asc
  • desc
tag
string Yes 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
enumerated Yes filter returned files by their visibility. 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. When the parameter is not specified, all files are returned.
If you set visibility to private, the shared parameter becomes mandatory.
Authorized values:
  • public
  • private
dF
date Yes Time stamp in milliseconds to filter content that has been added or modified from the specified time.
search
string Yes Filters the feed to contain only those documents that contain the specified value. When this parameter is passed, 'visibility' cannot be passed with a value of private. All parameters, other than 'visibility', 'page', 'ps', 'sortBy', 'sortOrder', 'sI' are ignored.
fileType
string Yes Filter content to only include content that is of the specified extension.
category
enumerated Yes Specifies resource types to include in the response. Multiple values are accepted, e.g. category=document&category=page
Authorized values:
  • document
  • page
includeDocumentTypeTitle
enumerated Yes If true, then look up document type title from document type id and add <td:documentTypeTitle> to the Document Entry. The default value is false.
Authorized values:
  • true
  • false
includeWorkingDrafts
enumerated Yes If true, includes working drafts inline, if there is a draft of an existing document then the draft will be provided instead of the document. The default value is false.
Authorized values:
  • true
  • false
includeAllowedSortKeys
boolean Yes If true, includes sortBy values in a comma-delimited list. Corresponding element name is td:allowedSortKeys. This parameter has a boolean value of either true or false. The default value is false.
includeFavorite
enumerated Yes Indicate whether to return favorite information of files in the feed. Default value is false.
Authorized values:
  • false
  • true
title
string Yes Filter the files with the title in library.
Name Type Optional Description
Authorization
enumerated No 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.
Authorized values:
  • bearer
  • basic
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
401
Unauthorized. Returned when calling this API without a valid authentication.
400
Bad Request. Returned when invalid query parameters are passed to the API
404
Item not found.
403
Forbidden. The server refuses to fulfill a request, typically because the request was for an object that you don't have permission to access.
500
Internal server error. The server encountered an unexpected condition that prevented it from fulfilling the request.
Examples
For personal files library
GET /files/basic/api/library/5d06ab0044ed8129bd5ebd4caeec5df1/feed HTTP/1.1 Host: example.com User-Agent: Thingio/1.0 

Response returned by the server
 Lotus Connections - Files
	urn:lsid:ibm.com:td:6a5982f3-ba41-4aa9-89ac-7c347b06f400
		Monifa Shani
		mshani
		mshani@renovations.com
		active
	2011-01-19T07:33:56.734Z 465
		
		application/*
		image/*
		*/*
	
		urn:lsid:ibm.com:td:e6080eec-c5b5-423d-a7ee-ebce4aefedcd
		e6080eec-c5b5-423d-a7ee-ebce4aefedcd
		testDownloadMediaRevision
			%one_245312ad-139a-4dfe-9f52-b07760894273.pdf
		
		
		
		
		
 
		
		
 
		
			Monifa Shani
			mshani
			mshani@renovations.com
			active
		
		
		2011-01-19T07:45:14.390Z
		2011-01-19T07:45:22.093Z
		2011-01-19T07:45:14.390Z
		2011-01-19T07:45:20.500Z
		
		
			Monifa Shani
			mshani
			mshani@renovations.com
			active
		
		private
		6a5982f3-ba41-4aa9-89ac-7c347b06f400
		personalFiles
		63a03d25-a16e-43bb-b3a5-c2f06685a936
		3
		true
		0
		0
		0
		0
		0
		3
		18
		
		
 
		6
		0
		false
		snx:file