Search result entry content 

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:

Table 1. Search return entry elements

Element How treated on input Description
<id> Ignored Unique identifier of the search result. This element does not identify the unique ID of the item referenced by the search result.
<title> Ignored Entry title; describes the item returned by the search.
<category scheme="http://www.ibm.com/xmlns/prod/sn/type" term="search"/> Required Identifies the Atom entry as a search result.
<category scheme="http://www.ibm.com/xmlns/prod/sn/component" term="<application_name>"/> Optional Identifies the IBM Connections application in which the result was found. Options are:

<category term="<tag_name>"/>
Repeats once for each tag of the search result.
<link rel="alternate" type="text/html" href="..."> Ignored 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>"> Ignored Bookmark link. Provided for all bookmarks, such as a bookmark added to a community or a bookmark created in the Bookmarks application.
<relevance:score> Ignored 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> Ignored A summary of the content of the search result. This element can be empty.
<updated> Ignored The date this entry was last modified, as defined in the Atom specification.
<author>
  <name>
  <email>
  <snx:userid>
  <snx:userState>
</author>

Ignored The person who originally created the item. This element can repeat if the item has multiple authors. 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.

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

<entry>
  <title>Red Cross</title> 
  <link href="http://www.membersforlife.org/cbsr/schedule/" /> 
  <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>Red Sox fans</title> 
  <link href="http://communities.enterprise.example.com/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="baseball-news" /> 
  <category term="redsox" /> 
  <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>


Parent topic

Search API Atom entry types

Related reference
Search for information programmatically
Retrieve the people related to a set of search results
Retrieve the tags related to a set of search results
Retrieve the applications related to a set of search results


   

 

});

+

Search Tips   |   Advanced Search