Community bookmark entry content
Added by IBM contributorIBM | Edited by Claudia R Elbourn on June 12, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Lists the elements in a bookmark Atom entry.
Tags: commapi

You can create bookmark entries in the Communities and Bookmarks services. Most elements of a bookmark are the same for both services. The first table lists the common elements; the additional tables define extensions used by the specific services.

All elements are in the http://www.w3.org/2005/Atom namespace, except those that are prefixed as follows:

snx

In the http://www.ibm.com/xmlns/prod/sn namespace.

 

Table 1. Bookmark entry elements

Element
How treated on input
Description
<id>
Ignored
Unique identifier of a bookmark.
<title type="text">
Required
Entry title; a descriptive title of the bookmark specified in text format. The type attribute is optional; type="text" is the default and only format allowed.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="bookmark"/>
Required
Identifies a bookmark entry.
<category term="tag_word"/>
Optional
Specifies a tag. A tag is a term used to categorize the bookmark. Repeat this element for each tag associated with the bookmark.
<link href="link_url"/>
Required
Specifies the web address to which the bookmark refers.

Note: Each user can have only one bookmark per web address.
<link rel="edit" type="application/atom+xml" href="edit_url"/>
Ignored
Specifies a URI from which you can retrieve the full content of the bookmark, as opposed to a summary. Use this URI to update or delete the bookmark.
<content type="html">
Required
Your description of the bookmarked resource.
<published>
Ignored
The date this entry was published, as defined in the Atom specification.
<updated>
Ignored
The date this entry was updated, as defined in the Atom specification.
<author>

			<name>

			<email>

			<snx:userid>

			<snx:userState>

			</author>
Ignored
The author of this entry, as defined in the Atom specification. If IBM® Connections is configured to prevent email addresses from being displayed, then the <email> element is not supported; provide the <snx:userid> instead. Otherwise, <email> can be used. The <name> and <snx:userState> elements are ignored on input.

 


Communities Extensions

The following elements are supported for bookmark entries in a community in addition to the common elements defined in Table 1.

Table 2. Bookmark entry elements specific to the Communities application

Element
How treated on input
Description
<category scheme="http://www.ibm.com/xmlns/prod/sn/flags" term="important"/>
Optional
If present, identifies the bookmark as an important bookmark. Important bookmarks are listed on the community home page.

 


Bookmarks Extensions

The following elements are supported for bookmark entries in the Bookmarks application in addition to the common elements defined in Table 1.

Table 3. Bookmark entry elements specific to the Bookmarks application

Element
How treated on input
Description
<category scheme="http://www.ibm.com/xmlns/prod/sn/flags" term="private"/>
Optional
Identifies the bookmark as private. Private bookmarks are not visible to users other than the author. If this flag is not present, the bookmark is visible to all readers.
<category scheme="http://www.ibm.com/xmlns/prod/sn/flags" term="internal"/>
Ignored
Identifies a bookmark that refers to a resource within a corporate intranet. If this flag is not present, the bookmark refers by default to a resource on the public Internet (World Wide web). The Bookmarks server uses IP ranges configured by the server administrator to determine whether bookmarks are internal or not. See "Administering IBM Connections" for more information.
<link rel="http://www.ibm.com/xmlns/prod/sn/same" type="application/atom+xml" href="same_url_feed">
Ignored
Link to an Atom feed of all user's bookmarks for the same URL.
<link rel="http://www.ibm.com/xmlns/prod/sn/icon" type="image/x-icon" href="icon_url"/>
Ignored
Specifies a URL from which you can retrieve the bookmark's icon. This link is only available when the parameter "showFavIcon=true" is used to retrieve the entry.

Note: This element should follow the <link rel=edit> element.
<snx:clickcount>
Ignored
Number of times the bookmark has been clicked.
<snx:link linkid="xxx-xxx">
Ignored
Unique ID of the bookmark.
<snx:linkcount>
Ignored
Total count of bookmarks to this web address, including this one.