Community articleGetting a list of bookmark tags
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

Retrieves a list of bookmark tags that match a specific search criteria. The list is returned in an Atom publishing protocol category document or as a plain text listing.



Retrieves a list of bookmark tags that match a specific search criteria. The list is returned in an Atom publishing protocol category document or as a plain text listing.
 

Usage notes


This API is designed to support the display of a tag cloud, so it only returns the top 80 tags. To display fewer tags in the cloud, and limit them to a subset of tags that you are interested in, specify one or more of the supported input parameters.

Request parameters


Separate multiple parameters with an ampersand (&).
 

Input
Method URI Description
GET /dogear/tags This API is designed to support the display of a tag cloud, so it only returns the top 80 tags. To display fewer tags in the cloud, and limit them to a subset of tags that you are interested in, specify one or more of the supported input parameters.
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.
format
enumerated Yes Output format of the returned tags. Options are:
atom
Returns the tags in an Atom document. This value is the default value.
li
Returns the tags in a HTML-formatted list.
txt
Returns a text listing of the tags.
Authorized values:
  • atom
  • li
  • txt
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
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.
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 retrieve a list of all the tags assigned to bookmarks created by the user with the user ID 937965j0-4f0c-1028-5a06-db08213b51b2:
GET /dogear/tags?userid=937965j0-4f0c-1028-5a06-db08213b51b2 HTTP/1.1

	Authorization: Basic ...

	Host: dogear.example.com:9443

	Accept: */*


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

	<app:categories xmlns:app="http://www.w3.org/2007/app" xmlns="http://www.w3.org/

	2005/Atom" xmlns:snx="http://www.ibm.com/xmlns/prod/sn" fixed="no">

	

	<category term="mlb" snx:frequency="9" />

	<category term="onlinenews" snx:frequency="10" />

	<category term="pen07l" snx:frequency="2" />

	<category term="publicnews" snx:frequency="4" />

	<category term="technews" snx:frequency="1" />

	<category term="ws07" snx:frequency="2" />

	</app:categories>