API Guide v2.0

Get Aggregated Bookmarks

Version 1 | Version 2

HTTP Method & URL
GET <base-url>?Type=AggregatedBookmark&Version=2&filter=<filter>&userId=<userid>
&communityId=<group-id>&url=<url>&authId=<auth_id>
Parameters
Type <required> Type of the request resource
Version <required> API version
filter <required> Filter is used to decide for which page the aggregated bookmarks should be computed. Valid values are:

TOPIC : Aggregated bookmarks in a give group. Same as aggregated bookmarks on Group Details page in the UI.
ALL_BOOKMARKS : Aggregated bookmarks in the open communities added by any user. Same as aggregated bookmarks on the All Bookmarks Page in the UI.
BOOKMARK : Aggregated bookmarks for the given search keyword. Same as aggregated bookmarks on the Search results page in the UI.
USER_TOPIC_BOOKMARK : Aggregated bookmarks for a given group added by a user. This option is added for Confluence Connector.
MY_BOOKMARKS : Aggregated bookmarks for a user's bookmarks. Though currently My Bookmarks page doesn't support aggregated bookmark feature, this option is used in Bookmarklet to check if a URL is already bookmarked by a user.

UserId Required when the filter value is:
  BOOKMARK, USER_TOPIC_BOOKMARK, or MY_BOOKMARKS
CommunityId Required when the filter value is:
  TOPIC or USER_TOPIC_BOOKMARK
url <required> The URL for which aggregated bookmarks should be retrieved
AuthId <optional> EMAIL_ADDR | LOGIN_ID
Specifies if the value in UserId parameter is the login-id or email-id.
Description
This API allows the user to retrieve bookmarks pointing to the same URL available in the same or different groups, added by the same or different users.
Filter Usage Examples

Filter : TOPIC
http://localhost/cbapp/restapi?Type=AggregatedBookmark&Version=1&authId=EMAIL_AD
DR&filter=TOPIC&userId=admin@mycompany.com&communityId=35&url=http%3A%2F%
2Fwww.bea.com%2Fframework.jsp%3FCNT%3Dhomepage_main.jsp%26FP%3D%2Fco
ntent

Filter : ALL_BOOKMARKS
http://localhost/cbapp/restapi?Type=AggregatedBookmark&Version=1&authId=EMAIL_AD
DR&filter=ALL_BOOKMARKS&userId=admin@mycompany.com&url=http%3A%2F%2Fw
ww.bea.com%2Fframework.jsp%3FCNT%3Dhomepage_main.jsp%26FP%3D%2Fcontent

Filter : BOOKMARK
http://localhost/cbapp/restapi?Type=AggregatedBookmark&Version=1&authId=EMAIL_AD
DR&filter=BOOKMARK&userId=admin@mycompany.com&url=http%3A%2F%2Fwww.bea
.com%2Fframework.jsp%3FCNT%3Dhomepage_main.jsp%26FP%3D%2Fcontent

Filter : USER_TOPIC_BOOKMARK
http://localhost/cbapp/restapi?Type=AggregatedBookmark&Version=1&authId=EMAIL_AD
DR&filter=USER_TOPIC_BOOKMARK&communityId=35&userId=admin@mycompany.co
m&url=http%3A%2F%2Fwww.bea.com%2Fframework.jsp%3FCNT%3Dhomepage_main.j
sp%26FP%3D%2Fcontent

Example Response
<?xml version="1.0" encoding="UTF-8" ?> 
<Response>
  <TimeStamp>2008-08-12 13:36:10 GMT</TimeStamp> 
  <APIVersion>2.0</APIVersion> 
  <Bookmarks>
    <Bookmark>
      <Title>Google</Title> 
      <URL>http://www.google.co.in/</URL> 
      <SaveCount>29</SaveCount> 
      <Id>4446</Id> 
      <Tags>
        <Tag>
          <Keyword>connectb eam</Keyword> 
          <Id>1382</Id> 
          <Weight>0</Weight> 
          <DateWeight>0</DateWeight> 
          <TagCount>0</TagCount> 
        </Tag>
      </Tags>
      <User>
        <UserName>Connectbeam Admin</UserName> 
        <Id>1</Id> 
      </User>
      <CreatedOn>5 hours ago</CreatedOn> 
      <Community>
        <Name>Application Demos</Name> 
        <Id>51</Id>
        <Type>open_group</Type>
      </Community> 
      <CommentCount>0</CommentCount> 
      <Comments> <Comments/> 
    </Bookmark>
    <Bookmark>
      <Title>Googlewq</Title> 
      <URL>http://www.google.co.in/</URL> 
      <Description>sdsfasdfas</Description> 
      <SaveCount>29</SaveCount> 
      <Id>3733</Id> 
      <Tags>
        <Tag>
          <Keyword>w</Keyword> 
          <Id>993</Id> 
          <Weight>0</Weight> 
          <DateWeight>0</DateWeight> 
          <TagCount>0</TagCount> 
        </Tag>
      </Tags>
      <User>
        <UserName>Connectbeam Admin</UserName> 
        <Id>1</Id> 
      </User>
      <CreatedOn>21 days ago</CreatedOn> 
      <Community>
        <Name>Agile Methodologies1 by nedu</Name> 
        <Id>22</Id>
        <Type>open_group</Type>
      </Community>
      <CommentCount>1</CommentCount> 
      <Comments>
        <Comment>
          <Id>85</Id> 
          <Description>qwd</Description> 
          <User>
          <UserName>Connectbeam Admin</UserName> 
          <Email>admin@mycompany.com</Email> 
          <Id>1</Id> 
          </User>
          <CreatedOn>July 22, 2008</CreatedOn> 
        </Comment>
      </Comments>
    </Bookmark>
  </Bookmarks>
</Response>
Notes:
  • Type values, as in <Community><Type>value</Type></Community>
    • private : User's private community
    • company : Public (shared with all)
    • group_restricted : Restricted Group
    • group_open : Open Group

back to top

©2008 Connectbeam, Inc.