Community articleSearch result entry content
Added by IBM contributorIBM on December 22, 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 an Atom entry representing the result returned by a search.

This article has been superseded by the Response Format section of the Search API article.




Lists the elements in an Atom entry representing the result returned by a search.

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

relevance:

In the http://a9.com/-/opensearch/extensions/relevance/1.0/ namespace.

Table 1. Search return entry elements

Element
Description
<id>
Unique identifier of the search result. This element does not identify the unique ID of the item referenced by the search result.
<title>
Entry title; describes the item returned by the search.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="search"/>
Identifies the Atom entry as a search result.
<category scheme="http://www.ibm.com/xmlns/prod/sn/component" term="<application_name>"/>
Identifies the IBM® Connections application in which the result was found. Options are:
  • activities
  • blogs
  • communities
  • dogear
  • files
  • forums
  • profiles
  • wikis
  • status_updates
<category term="<tag_name>"/>
Repeats once for each tag of the search result.
<link rel="alternate" type="text/html" href="...">
Link to use to display the search result in the IBM Connections user interface. Not provided for bookmarks; see the link element below.
<link ref="bookmark_url">
Bookmark link. Provided for all bookmarks, such as a bookmark added to a community or a bookmark created in the Bookmarks application.
<relevance:score>
Relevance ranking of the search result. This is a relative score of an individual search result. Values typically range between 0 and 1, but values greater than 1 can result and should be considered equivalent to a score of 1. For example: <relevance:score>0.2736998</relevance:score>

Go to the following external web site for more information: http://www.opensearch.org/Specifications/OpenSearch/Extensions/Relevance/1.0/Draft_1
<summary>
A summary of the content of the search result. This element can be empty.
<updated>
The date this entry was last modified, as defined in the Atom specification.
<author>
<name>
<email>
<snx:userid>
<snx:userState>
</author>
The person who originally created the item. This element can repeat if the item has multiple authors. If IBM


The following entry is an example of a bookmark returned by a Bookmarks application search:

<entry>
<title>Example</title>
<link href="http://example.org" />
<id>urn:uri:1532187</id>
<updated>2007-06-04T07:51:34+01:00</updated>
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="search" />
<category scheme="http://www.ibm.com/xmlns/prod/sn/component" term="dogear" />
<author>
<name>Shannon Nixon</name>
<snx:userid>33225f40-8f0a-1028-9e75-db09982b51j2</snx:userid>
</author>
<summary type="html" />
<relevance:score>5.5948286</relevance:score>
</entry>


The following entry is an example of a community returned by a search:

<entry>
<title>Sports Fans</title>
<link href="http://communities.example.org/communities/service/html/
communityview?communityUuid=AD2H091E0E92D2C6J526E73F877A250016W2"
rel="alternate" type="text/html" />
<id>urn:uri:597414</id>
<updated>2008-04-27T09:16:17+01:00</updated>
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="search" />
<category scheme="http://www.ibm.com/xmlns/prod/sn/component"
term="communities" />
<category term="forum" />
<category term="blog" />
<category term="baseball" />
<author>
<name>Stephen Brady</name>
<snx:userid>97ae7640-8f0a-1028-8411-db88423b51b2</snx:userid>
</author>
<summary type="html" />
<relevance:score>5.292409</relevance:score>
</entry>