Pinning a folder
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 30, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

To pin a folder, provide either an Atom document representing the collection as input to the request or identify the folder by providing the itemId parameter on the request. Send a POST request to the myfavorites feed.
 

 

Input
Method URI Description
POST /files/{auth}/api/myfavorites/collections/feed Pin a folder
Content Type: application/atom+xml
Sample Request:
<entry></entry>
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
itemId
string No String. Uuid that uniquely identifies the folder. The uuid is defined in the <td:uuid> element in the Atom entry document of the folder.
filesAddedNotification
enumerated Yes String. Indicates whether the collection should be added to notification at the same time. Options are on and off. The default value is on.
Authorized values:
  • on
  • off
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
Code Description
204
Indicates that the versions were successfully removed from the collection.
401
Unauthorized.
403
Forbidden.
404
Not Found.