Community articleGetting a feed of all bookmarks
Added by IBM contributorIBM on June 20, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Return a feed of bookmarks. You can search for a set of bookmarks that match a specific criteria by providing input parameters on the request.



Return a feed of bookmarks. You can search for a set of bookmarks that match a specific criteria by providing input parameters on the request.
 

Usage notes


You can use this resource to subscribe to a set of bookmarks and get notifications of changes.

Request parameters


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

 

Input
Method URI Description
GET /dogear/atom You can use this resource to subscribe to a set of bookmarks and get notifications of changes.
Name Type Optional Description
access
enumerated Yes Filters the bookmarks based on whether they are private or public. Options are:
any
Returns all bookmarks only if the request is made over secure http (https). If the request is made over https, it is redirected to the /mybookmarks URI. If the request is made over http, only public bookmarks are returned. This value is the default value.
private
Only returns private bookmarks. Private bookmarks can only be accessed by their owner, and only if the owner is authenticated. The user is prompted to log in and is redirected to the /mybookmarks URI from which only private bookmarks are returned.
public
Only returns public bookmarks.
Authorized values:
  • any
  • private
  • public
base
string Yes Returns only bookmarks to pages hosted by a given web site. For example, to retrieve only bookmarks to pages on the web site www.w3c.org/TR, specify "base=www.w3.org/TR"
email
string Yes Internet email address. Returns bookmarks created by the user specified by the email address. Format the HTTP request using the proper URL encoding. For example, the encoded form of the @ symbol is %40 as in:
adam_eventide%40garden.com
Note: Do not use this parameter if IBM® Connections is configured to prevent email addresses from being displayed. Use the userid parameter instead.
lang
string Yes Language code. Language for strings in the output. If not specified, the language specified by the first matching client, typically the web browser, is used, if available. The server then redirects the request to add this parameter to the URL. Specify this parameter to avoid the redirect.
network
enumerated Yes Filters the bookmarks based on the network that it is available from. Options are:
all
Returns all bookmarks. This value is the default value.
internet
Only returns the bookmarks that link to Internet resources, which are visible outside the intranet firewall.
intranet
Only returns the bookmarks that link to resources available on the corporate intranet, that is, resources that are not externally visible.
Authorized values:
  • all
  • internet
  • intranet
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 50.
search
string Yes Well-formed full text search query. Performs a text search on the title, description, and tags of all bookmarks. Orders results by relevance. Respects other constraints. See Advanced search options in the Using section of the wiki for details on the search operators you can use in the search query to perform advanced searches for bookmarks.
Note: When you use this parameter, search can only find bookmarks that the indexer has processed. The indexing interval is stored in a configuration property that your administrator can configure. See Managing search and index operations in the Administering section of the wiki for more details.
searchOperator
enumerated Yes Default operator between search terms. Options are:
and
or
The default value is set by your system administrator. Use in conjunction with "search" parameter to override the system default operator for search queries.
Authorized values:
  • and
  • or
showFavIcon
boolean Yes Includes links to bookmark icons (also known as "favorite icons") in the response. Bookmarks uses link relation "http://www.ibm.com/xmlns/prod/sn/icon" to identify this link in a bookmark Atom entry. Boolean. Options are:
false
Links to bookmark icons are not included. This value is the default value.
true
Includes links to bookmark icons.
since
string Yes Includes in the resulting feed all bookmarks updated after a specified date. Specify the date using a date-time value that conforms to RFC3339. Use an upper case "T" to separate the date and time, and an uppercase "Z" in the absence of a numeric time zone offset. For example: 2009-01-04T20:32:31.171Z.
sortBy
enumerated Yes Specifies how the results should be sorted. Options are:
created
Sorts the entries by the date the item was created. This value is the default value.
popularity
Sorts the entries by how popular the item is.
Note: This parameter replaces the sort parameter. The sort parameter and its associated options (date and popularity) are supported for backwards compatibility only; they will be deprecated in a future release.
Authorized values:
  • created
  • popularity
tag
string Yes Returns bookmarks with the specified tag. You can search for multiple tags; separate the tags with a space or comma. If you use a space, URL-encode the space using %20. Only bookmarks with all of the tags that you specify are returned.
url
string Yes A well-formed web address. Returns bookmarks for the given web address. When you use this parameter, all other search parameters are ignored.
userid
string Yes Unique ID that represents a specific person.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
To search for all bookmarks that are tagged with candy:
> GET /dogear/atom?tag=candy&lang=en HTTP/1.1

	> Authorization: Basic ...

	> Host: dogear.enterprise.example.com:9084

	> Accept: */*



Response returned by the server
<?xml version="1.0" encoding="utf-8" ?>

	<feed

	xmlns="http://www.w3.org/2005/Atom"

	xmlns:snx="http://www.ibm.com/xmlns/prod/sn"

	xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">

	<generator

	uri="http://www.ibm.com/xmlns/prod/sn"

	version="2.5">IBM Connections - Dogear</generator>

	<title>Bookmarks - Bookmarks with Tags: candy</title>

	<link

	rel="self"

	type="application/atom+xml"

	href="http://dogear.enterprise.example.com:9084/dogear/atom?tag=candy&lang=en"

	/>

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud"

	type="application/atomcat+xml"

	href="http://dogear.enterprise.example.com:9084/dogear/tags?tag=candy&lang=en"

	/>

	<link

	rel="alternate"

	type="text/html"

	href="http://dogear.enterprise.example.com:9084/dogear/html?tag=candy&lang=en"

	/>

	<opensearch:totalResults>3</opensearch:totalResults>

	<id>tag:dogear.ibm.com,2005:feed:/?tag=candy&lang=en</id>

	<updated>2008-02-07T14:47:21-05:00</updated>

	<entry>

	<id>tag:dogear.ibm.com,2005:link:7EDG7F0000011A9595DFCD976AA63900000C</id>

	<title>M&M's.com</title>

	<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="bookmark" />

	<link href="http://www.mms.com/" />

	<content type="html">

	<! [CDATA [

	<div><p>

	The M&M web site.

	</p></div>

	]]&gt;

	</content>

	<published>2008-02-07T14:47:21-05:00</published>

	<updated>2008-02-07T14:47:21-05:00</updated>

	<category term="candy" />

	<author>

	<email>amy_jones5@us.example.com</email>

	<name>Amy jones5</name>

	<snx:userid>9bf4efz0-8j0y-1028-8b5a-db08283b51b2</snx:userid>

	<uri>http://dogear.enterprise.example.com:9084/dogear/html?

	userid=9bf4efz0-8j0y-1028-8b5a-db08283b51b2&lang=en</uri>

	</author>

	<snx:clickcount>0</snx:clickcount>

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/same"

	type="application/atom+xml"

	href="http://dogear.enterprise.example.com:9084/dogear/atom?

	for=http%3a%2f%2fwww.mms.com%2f&lang=en" />

	</entry>

	<entry>

	<id>tag:dogear.example.com,2005:link:8DFG7F0000011A9595DFCD976AA63900000B</id>

	<title>M&M's.com</title>

	<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="bookmark" />

	<link href="http://www.mms.com/" />

	<content type="html">

	<! [CDATA [

	<div><p>

	The M&M web site.

	</p></div>

	]]&gt;

	</content>

	<published>2008-02-07T13:44:45-05:00</published>

	<updated>2008-02-07T13:44:45-05:00</updated>

	<category term="candy" />

	<author>

	<email>amy_jones11@us.example.com</email>

	<name>Amy jones11</name>

	<snx:userid>9bf4efz0-8j0y-1028-8b5a-db08253b51b2</snx:userid>

	<uri>http://dogear.enterprise.example.com:9084/dogear/html?

	userid=9bf4efz0-8j0y-1028-8b5a-db08253b51b2&lang=en</uri>

	</author>

	<snx:clickcount>1</snx:clickcount>

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/same"

	type="application/atom+xml"

	href="http://dogear.enterprise.example.com:9084/dogear/atom?

	for=http%3a%2f%2fwww.mms.com%2f&lang=en" />

	</entry>

	<entry>

	<id>tag:dogear.example.com,2005:link:D4DG7F000001FA4D5E7554114007F500002F</id>

	<title>Hershey's</title>

	<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="bookmark" />

	<link href="http://www.hersheys.com" />

	<content type="html">

	<! [CDATA [

	<div><p>

	

	<div>

	<div>

	<p>Bookmark 2 of 3 created on day 30</p>

	</div>

	

	<br />

	<br />

	</div>

	</p></div>

	]]&gt;

	</content>

	<published>2007-12-17T16:46:16-05:00</published>

	<updated>2007-12-17T16:46:17-05:00</updated>

	<category term="bookmark" />

	<category term="candy" />

	<category term="chocolate" />

	<author>

	<email>buser91@us.example.com</email>

	<name>Bill User91</name>

	<snx:userid>9bf4efz0-8j0y-1028-8b5a-db08223b51b2</snx:userid>

	<uri>http://dogear.enterprise.example.com:9084/dogear/html?

	email=buser91%40us.example.com&lang=en</uri>

	</author>

	<snx:clickcount>0</snx:clickcount>

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/same"

	type="application/atom+xml"

	href="http://dogear.enterprise.example.com:9084/dogear/atom?

	for=http%3a%2f%2fwww.hersheys.com&lang=en"

	/>

	</entry>

	</feed>

To search for all bookmarks created by the user with the user ID 9bf4efz0-8j0y-1028-8b5a-xc07163b51b2:
GET /dogear/atom?userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2

	> Authorization: Basic ...

	> Host: dogear.example.com:9443

	> Accept: */*


Response returned by the server
<?xml version="1.0" encoding="utf-8"?>

	<feed

	xmlns="http://www.w3.org/2005/Atom"

	xmlns:snx="http://www.ibm.com/xmlns/prod/sn"

	xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/">

	<generator

	uri="http://www.ibm.com/xmlns/prod/sn"

	version="2.5">IBM Connections - Dogear

	</generator>

	<title>Bookmarks - Bookmarks for 9bf4efz0-8j0y-1028-8b5a-xc07163b51b2</title>

	<link

	rel="self"

	type="application/atom+xml"

	href="https://dogear.example.com:9443/dogear/api/app?

	email=mary_lou%40example.com&amp;sort=date&amp;sortOrder=desc&amp;lang=en_US" />

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/tag-cloud"

	type="application/atomcat+xml"

	href="https://dogear.example.com:9443/dogear/tags?userid=

	9bf4efz0-8j0y-1028-8b5a-xc07163b51b2&amp;sort=date&amp;

	sortOrder=desc&amp;lang=en_US" />

	<link

	rel="next"

	href="https://dogear.example.com:9443/dogear/api/app?

	userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2&amp;page=2&amp;

	sort=date&amp;sortOrder=desc&amp;

	lang=en_US" type="application/atom+xml"/>

	<link

	rel="last"

	href="https://dogear.example.com:9443/dogear/api/app?

	userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2&amp;page=2&amp;

	sort=date&amp;sortOrder=desc&amp;

	lang=en_US" type="application/atom+xml"/>

	<link

	rel="alternate"

	type="text/html"

	href="https://dogear.example.com:9443/dogear/html?userid=

	9bf4efz0-8j0y-1028-8b5a-xc07163b51b2&amp;sort=date&amp;sortOrder=desc&amp;

	lang=en_US"/>

	<opensearch:totalResults>20</opensearch:totalResults>

	<id>tag:dogear.ibm.com,2005:feed:/?userid=9bf4efz0-8j0y-1028-8b5a-xc07163b51b2

	&amp;sort=date&amp;sortOrder=desc&amp;lang=en_US</id>

	<updated>2007-12-20T11:44:48-05:00</updated>

	<author>

	<name>LCserver1@us ibm com</name>

	<email>mary_lou@example.com</email>

	<snx:userid>9bf4efz0-8j0y-1028-8b5a-xc07163b51b2</snx:userid>

	</author>

	<entry>

	<id>tag:dogear.ibm.com,2005:link:EC8G0921951A5CBCF2ED0D51A8C20B00000D</id>

	<title>Red Sox Home Page&lt;07 World Series Champs&amp;Ben&#039;s

	Favorite&gt;</title>

	<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="bookmark" />

	<link href="http://boston.redsox.mlb.com" />

	<link rel="edit"

	type="application/atom+xml"

	href="https://dogear.example.com:9443/dogear/api/app?

	url=http%3a%2f%2fboston.redsox.mlb.com" />

	<content type="html"><! [CDATA [

	<div>

	<p>

	<div>

	<p>World Series Bound&lt;07 World Series Champs&amp;Ben's

	Favorite&gt;</p>

	</div>

	</p>

	</div>

	]]&gt;</content>

	<published>2007-12-20T11:44:44-05:00</published>

	<updated>2007-12-20T11:44:44-05:00</updated>

	<category term="04ws"/>

	<category term="mlb"/>

	<category term="ws07"/>

	<author>

	<email>mary_lou@example.com</email>

	<name>Mary Lou</name>

	<snx:userid>9bf4efz0-8j0y-1028-8b5a-xc07163b51b2</snx:userid>

	<uri>https://dogear.example.com:9443/dogear/html?userid=

	9bf4efz0-8j0y-1028-8b5a-xc07163b51b2</uri>

	</author>

	<snx:clickcount>0</snx:clickcount>

	<link

	rel="http://www.ibm.com/xmlns/prod/sn/same"

	type="application/atom+xml"

	href="https://dogear.example.com:9443/dogear/atom?

	for=http%3a%2f%2fboston.redsox.mlb.com" />

	</entry>

	...

	</feed>