Community articleSearch API
Added by IBM contributorIBM | Edited by Gili Nachum on December 10, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars1 comment

Search IBM Connections to find content that, for example, contains a specific text string in its title or content, or is tagged with a specific tag.

This document describes the API call for searching IBM Connections to find content that, for example, contains a specific text string in its title or content, or is tagged with a specific tag.

Important Performance Notes

  1. This API should NOT be used to power a type-ahead like experience.
  2. Wildcard queries (have trailing star character) are a best-effort service that is subject to request rate limits (any such query could result in error, depending on server load). Therefore avoid defining API queries which includes a wildcard.
    A wildcard query is expensive to compute,  and is designed to be used by advanced end-users when constructing a complex query text on rare occasions.
    When using a wildcard results might be partial and are not sorted by relevance, in addition, language analysis is not applied ('babies*' will not match 'baby').


Request Format


Context Paths


There are a number of different context paths available for this API in order to allow for different authentication mechanisms:-

 
Context Path
Authentication
/search/atom/search
None
/search/atom/mysearch
Basic
/search/atomfba/mysearch
Form Based
/search/oauth/atom/mysearch
OAuth

Parameters


The order of the parameters in the requests do not matter. The parameter names are case-sensitive; they must be entered in the format documented. Any unknown or unsupported parameters submitted as part of a request will be ignored.

The request should be a standard HTTP GET or POST command. When the request is GET the URL is formed by combining the search server's host name, port and path; as well as a collection of name-value pairs (input parameters) separated by & characters. Any parameter value must be URL-escaped if in GET request. When the request is POST the search server's host name, port and path, as well as a collection of name-value pairs (input parameters) are past on the request as parameters.


 

Name
Description
Comments
locale Locale of request client
  • any message returned will be in the client locale
  • available scopes and collections titles and description will be in the client locale
  • sorting method might be effected by the locale
  • Any additional information in the search results that are locale aware, like description
Specifies the language to use to parse the search request. See ISO-639 and ISO-3166 for valid values, e.g. "en_US". This parameter is optional. When specified, the appropriate dictionary for the specified language is used. Note: The dictionary for the language specified must be enabled for this parameter to work.
query Search query Text to search for. Returns a list of results with the specified text in the title, description, or content. Encode the strings. By default, spaces are treated as an AND operator. The following operators are supported:
  • AND or &&: Searches for items that contain both words. For example: query=red%20AND%20test returns items that contain both the word red and the word test. AND is the default operator.
  • NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain the word test, but not the word red.
  • OR: Searches for items that contain either of the words. For example: query=test%20OR%20red
  • To search for a phrase, enclose the phrase in quotation marks (" ").
  • +: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain the word test and many that also contain red, but none that contain only the word red.
  • ?: Use a question mark to match individual characters. For example: query=te%3Ft returns items that contain the words test, text, tent, and others that begin with te.
  • -: The dash prohibits the return of a given word. This operator is similar to NOT. For example: query=test%20-red returns items that contains the word test, but not the word red.
Note: Wildcard searches are permitted, but wildcard only searches (*) are not.
For more details about supported operators, see Advanced search options in the Using section of the product documentation
queryLang Language of the query string Specifies the language to use to parse the query parameter. See ISO-639 and ISO-3166 for valid values, e.g. "en_US". This parameter is optional. When specified, the appropriate dictionary for the specified language is used. Note: The dictionary for the language specified must be enabled for this parameter to work.
start Offset to first result to return in results Defines an offset from the first result in the set. This parameter is ignored if a page parameter is provided. This starts from 0. The default is 0. If specified value is negative, the value will be defaulted to 0; if the specified value is greater than the number of results, no results will be returned.
page Page number Specifies the page to be returned. The default value is 1, which returns the first page.
pageSize Number of results desired for a single request Specifies the number of entries to return per page. The minimum value is zero (negative values default to zero). The default value is 10. The maximum value you can specify is 150.
scope Identifier of which scope to search; the list of valid scopes is available from the Scopes API Default is to search over all scopes.
social Allows constraining the search results according to the provided social criteria. Refer to Social parameter to Search API for more information.
sortKey The key which controls the sorting order of the search results The following values are supported: "date" and "relevance". A valid value for this parameter is one of these values, or the name of any other sortable field.
sortOrder Determines the order by which the results are sorted: ascending or descending The only valid values are "asc" or "desc"
constraint Allows constraining the search results according to the provided criteria. Refer to Constraints for more information.
notconstraint Allows constraining the search results according to the NOT of the provided criteria. Refer to Constraints for more information.
facet Specify which facets will be returned for the query, in addition to search results. Refer to Facets for more information.
includeField Specify a field identifier that it not returned by default and should be returned for this specific request This parameter can appear many time so many fields can be retrieved and included as part of the search results
evidence Specify whether or not the results should be augmented with evidence information. The representation of evidence elements is described in Evident Element.
highlight Specify whether or not the search terms should be highlighted in the search results. If the value is [] the search terms will not be highlighted. Otherwise, the search terms will be highlighted.

Examples

  • Blogs containing the word red and bookmarked in Bookmarks: query=red&scope=blogs&scope=dogear
  • Items containing the word red and tagged with the term colour: query=red&constraint={"type": "category", "values":["Tag/colour"]}
  • Field value query using constraint parameter: constraint={"type":"field","id":"title","values":["test"],"exactMatch":false}
  • Tag query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1"]}
  • Tag OR query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1","Tag/tag2"]}
  • Source (components) OR query using constraint parameter: constraint={"type":"category","values":["Source/forums","Source/profiles","Source/wikis","Source/status_updates"]}
  • Tag AND query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1"]}&constraint={"type": "category", "values":["Tag/tag2"]}
  • Tag query using social parameter: social={"type":"tag","id":"tag1"}
  • Person query by user ID using social parameter: social={"type":"personEmail","id":"ajones105@janet.iris.com"}
  • Person query by email using social parameter: social={"type":"personUserId","id":"51a43040-0101-102e-8942-f78755f7e0ed"}
  • Community query using social parameter: query=test&social={"type":"community","id":"b4a83f35-d7e0-4633-8880-eab4c8d78d6d"}
  • Disable highlighting of the search terms: query=test&highlight=[]

Response Format


The response is Atom compliant. The table below describes the significance of the elements returned in the response:

 

 

Section
Remarks
/feed The container element for metadata and data that is associated with the search results feed.
/feed/title Descriptive title of the feed.
/feed/link[@href] Reference from the feed to a Web resource.
/feed/link[@rel= "next"|"previous"|"first"|"last"] "first", "last", "next" and "previous" links are included, as appropriate, for supporting RFC5005 Section-3.
/feed/author/name Description of the feed generator.
/feed/id Permanent, universally unique identifier for the feed.
/feed/generator Identifies the agent used to generate the feed, for example "IBM Connections - Search".
/feed/generator[@version] Indicates the version of the generating agent, for example "4.0".
/feed/updated Date/time the query was issued. The value will conform to the date-time production in RFC3339.
/feed/spelling:spelling The spelling element is used to suggest a spelling correction for the query.
/feed/spelling:spelling/spelling:suggestion The suggestion sub-element is an atom:text construct that specifies the suggested spelling correction for the query.
/feed/spelling:spelling/spelling:prompt The prompt sub-element is an atom:text construct that specifies the prompt text displayed near the spelling suggestion.
/feed/spelling:spelling/link The link sub-element of spelling is an Atom Link element whose link targets search requests for the suggested spell-corrected query.
/feed/spelling:spelling/link[@rel] The rel attribute value will be "spelling".
/feed/openSearch:totalResults Total number of results for submitted query.
/feed/openSearch:Query Contains information about the query that was submitted by the user.
/feed/openSearch:Query[@role] The role attribute value will be "request".
/feed/openSearch:Query[@searchTerms] Represents the user submitted query terms.
/feed/openSearch:Query/ibmsc:constraint Represents a constraint set in the request
/feed/openSearch:Query/ibmsc:constraint[@type] The constraint type: "category", "range" or "field"
/feed/openSearch:Query/ibmsc:constraint[@id] The constraint id of field and range constraints
/feed/openSearch:Query/ibmsc:constraint[@datatype] The data type of field and range constraints
/feed/openSearch:Query/ibmsc:constraint[@label] The label of field and range constraints
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue The constraint value
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@id] The value id for "category" and "field" constraints
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@label] The label of the constraint value.
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@lowerInclusive ] Lower inclusive value for range constraints.
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@upperInclusive ] Upper inclusive value for range constraints.
/feed/openSearch:itemsPerPage Number of search results returned in this feed.
/feed/entry Encompasses the information for a single search result.
/feed/entry/category Conveys information about a category (often corresponding to a facet) associated with an entry. Refer to Categories in Search API responses for more information.
/feed/entry/category@term A string that identifies the category to which the entry belongs. Refer to Categories in Search API responses for more information.
/feed/entry/category@scheme An IRI that identifies a categorization scheme. Refer to Categories in Search API responses for more information.
/feed/entry/title Text construct that conveys a human-readable title for an entry.
/feed/entry/title[@type] Indicates whether the text construct is "text", "html" or "xhtml". Text construct is "text" if not otherwise specified.
/feed/entry/link Defines a reference to the search result resource.
/feed/entry/link[@rel] Indicates the link relation type. If not present, the link relation type is "alternate".
/feed/entry/link[@href] URI link to document
/feed/entry/link[@type] Content type of the URI document link is an advisory media type.
/feed/entry/relevance:score Indicates a relative assessment of relevance for a particular search result with respect to the search query.
/feed/entry/updated Last modified date for the document. The value will conform to the date-time production in RFC3339.
/feed/entry/id Unique identifier of the document.
/feed/entry/summary Text construct that conveys a short summary, abstract, or excerpt of an entry.
/feed/entry/summary[@type] Indicates whether the text construct is "text", "html" or "xhtml". Text construct is "text" if not otherwise specified.
/feed/entry/author A person construct that indicates the author of the entry or feed.
/feed/entry/author/name Human-readable name for the person.
/feed/entry/author/snx:userid Identifier associated with the person.
/feed/entry/author/email The person email address. This may not be returned as part of the feed depending on the IBM Connections configuration settings.
/feed/entry/author/snx:userState The user state associated with the person. Possible values are active and inactive.
/feed/entry/contributor A person construct that indicates a person who contributed to the entry.
/feed/entry/contributor/name Human-readable name for the person.
/feed/entry/contributor/snx:userid Identifier associated with the person.
/feed/entry/contributor/email The person email address. This may not be returned as part of the feed depending on the IBM Connections configuration settings.
/feed/entry/contributor/snx:userState The user state associated with the person. Possible values are active and inactive.
/feed/entry/ibmsc:field This element is used to represent the name and value of a field of a document. The id attribute represents the name of the field. The body of the element represents the value of the field. Additional fields will be included in the search result response if specified through the includeField parameter.
/feed/entry/ibmsc:entity_evidence Refer to Evidence Element for more information.
/feed/entry/snx:communityUuid The unique identifier of the community this document is associated with.
/feed/entry/snx:rank Number of likes for the entry. The scheme attribute will be "@nowiki@www.ibm.com/xmlns/prod/sn/recommendation".
/feed/ibmsc:facets Refer to Facets for more information.
   

Example


To search for all content across IBM Connections that contains the text Red, send the following HTTP request:

> GET /search/atom/search/results?query=%22Red%22 HTTP/1.1

> Host: example.enterprise.com:9443

> Accept: */*


The following content is returned by the server:

<?xml version="1.0" encoding="UTF-8" ?>

<feed

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

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

xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/"

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

<title>"Red"</title>

<link

href="https://example.org:9443/search/atom/search/

results?query=%22Red%22" rel="self" />

<updated>2008-10-07T22:58:03Z</updated>

<id>https://example.org:9443/search/atom/search/

results?query=%22Red%22</id>

<openSearch:totalResults>2309</openSearch:totalResults>

<openSearch:itemsPerPage>10</openSearch:itemsPerPage>

<openSearch:startIndex>1</openSearch:startIndex>

<link

href="http://search-server:9080/search/atom/search/facets/

source?query=%22Red%22" rel="related" />

<link href="http://search-server:9080/search/atom/search/facets/

tags?query=%22Red%22" rel="related" />

<link href="http://search-server:9080/search/atom/search/facets/

people?query=%22Red%22" rel="related" />

<link href="http://search-server:9080/search/atom/search/

results?query=&quot;Red&quot;&page=2" rel="next" />

<link href="http://search-server:9080/search/atom/search/

results?query=&quot;Red&quot;&page=230" rel="last" />

<openSearch:Query role="request" searchTerms=""Red"" />

<entry>

<title>Title</title>

<link href="http://example.org/" />

<id>urn:uri:1547735</id>

<updated>2007-12-22T13:26:40+00: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" />

<category term="red" />

<category term="sports" />

<category term="baseball" />

<author>

<name>John E. Smith</name>

<snx:userid>177crjc0-8f0a-1028-8f0c-db93503b53t4</snx:userid>

</author>

<summary type="html" />

<relevance:score>5.4105196</relevance:score>

</entry>

...

</feed>

 
Input
Method URI Description
GET /search/atom/search Authentication: None
GET /search/atom/mysearch Authentication: Basic
GET /search/atomfba/mysearch Authentication: Form Based
GET /search/oauth/atom/mysearch Authentication: OAuth
Name Type Optional Description
locale
string Yes Specifies the language to use to parse the search request. See ISO-639 and ISO-3166 for valid values, e.g. "en_US". This parameter is optional. When specified, the appropriate dictionary for the specified language is used. Note: The dictionary for the language specified must be enabled for this parameter to work.
query
string Yes Text to search for. Returns a list of results with the specified text in the title, description, or content. Encode the strings. By default, spaces are treated as an AND operator. The following operators are supported:
AND or &&: Searches for items that contain both words. For example: query=red%20AND%20test returns items that contain both the word red and the word test. AND is the default operator.
NOT or !: Excludes the word that follows the operator from the search. For example: query=test%20NOT%20red returns items that contain the word test, but not the word red.
OR: Searches for items that contain either of the words. For example: query=test%20OR%20red
To search for a phrase, enclose the phrase in quotation marks (" ").
+: The plus sign indicates that the word must be present in the result. For example: query=+test%20red returns only items that contain the word test and many that also contain red, but none that contain only the word red.
?: Use a question mark to match individual characters. For example: query=te%3Ft returns items that contain the words test, text, tent, and others that begin with te.
-: The dash prohibits the return of a given word. This operator is similar to NOT. For example: query=test%20-red returns items that contains the word test, but not the word red.
Note: Wildcard searches are permitted, but wildcard only searches (*) are not.
For more details about supported operators, see Advanced search options in the Using section of the product documentation.
queryLang
string Yes Specifies the language to use to parse the query parameter. See ISO-639 and ISO-3166 for valid values, e.g. "en_US". This parameter is optional. When specified, the appropriate dictionary for the specified language is used. Note: The dictionary for the language specified must be enabled for this parameter to work.
start
int Yes Defines an offset from the first result in the set. This parameter is ignored if a page parameter is provided. This starts from 0. The default is 0. If specified value is negative, the value will be defaulted to 0; if the specified value is greater than the number of results, no results will be returned.
page
int Yes Specifies the page to be returned. The default value is 1, which returns the first page.
pageSize
int Yes Specifies the number of entries to return per page. The minimum value is zero (negative values default to zero). The default value is 10. The maximum value you can specify is 150.
scope
string Yes Identifier of which scope to search; the list of valid scopes is available from the Scopes API

Default is to search over all scopes.
social
string Yes Allows constraining the search results according to the provided social criteria.
Refer to Social parameter to Search API for more information.
sortKey
string Yes The key which controls the sorting order of the search results

The following values are supported: "date" and "relevance". A valid value for this parameter is one of these values, or the name of any other sortable field.
sortOrder
enumerated Yes Determines the order by which the results are sorted: ascending or descending

The only valid values are "asc" or "desc"
Authorized values:
  • asc
  • desc
constraint
string Yes Allows constraining the search results according to the provided criteria.

Refer to Constraints for more information.
notconstraint
string Yes Allows constraining the search results according to the NOT of the provided criteria.
Refer to Constraints for more information.
facet
string Yes Specify which facets will be returned for the query, in addition to search results.

Refer to Facets for more information.
includeField
string Yes Specify a field identifier that it not returned by default and should be returned for this specific request

This parameter can appear many time so many fields can be retrieved and included as part of the search results
evidence
string Yes Specify whether or not the results should be augmented with evidence information.
The representation of evidence elements is described in Evident Element.
highlight
string Yes Specify whether or not the search terms should be highlighted in the search results.
If the value is [] the search terms will not be highlighted. Otherwise, the search terms will be highlighted.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
Blogs containing the word red and bookmarked in Bookmarks: query=red&scope=blogs&scope=dogear Items containing the word red and tagged with the term colour: query=red&constraint={"type": "category", "values":["Tag/colour"]} Field value query using constraint parameter: constraint={"type":"field","id":"title","values":["test"],"exactMatch":false} Tag query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1"]} Tag OR query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1","Tag/tag2"]} Source (components) OR query using constraint parameter: constraint={"type":"category","values":["Source/forums","Source/profiles","Source/wikis","Source/status_updates"]} Tag AND query using constraint parameter: constraint={"type": "category", "values":["Tag/tag1"]}&constraint={"type": "category", "values":["Tag/tag2"]} Tag query using social parameter: social={"type":"tag","id":"tag1"} Person query by user ID using social parameter: social={"type":"personEmail","id":"ajones105@janet.iris.com"} Person query by email using social parameter: social={"type":"personUserId","id":"51a43040-0101-102e-8942-f78755f7e0ed"} Community query using social parameter: query=test&social={"type":"community","id":"b4a83f35-d7e0-4633-8880-eab4c8d78d6d"} Disable highlighting of the search terms: query=test&highlight=[]

Response returned by the server
 
Section
	
Remarks
/feed
	
The container element for metadata and data that is associated with the search results feed.
/feed/title
	
Descriptive title of the feed.
/feed/link[@href]
	
Reference from the feed to a Web resource.
/feed/link[@rel= "next"|"previous"|"first"|"last"]
	
"first", "last", "next" and "previous" links are included, as appropriate, for supporting RFC5005 Section-3.
/feed/author/name
	
Description of the feed generator.
/feed/id
	
Permanent, universally unique identifier for the feed.
/feed/generator
	
Identifies the agent used to generate the feed, for example "IBM Connections - Search".
/feed/generator[@version]
	
Indicates the version of the generating agent, for example "4.0".
/feed/updated
	
Date/time the query was issued. The value will conform to the date-time production in RFC3339.
/feed/spelling:spelling 	The spelling element is used to suggest a spelling correction for the query.
/feed/spelling:spelling/spelling:suggestion 	The suggestion sub-element is an atom:text construct that specifies the suggested spelling correction for the query.
/feed/spelling:spelling/spelling:prompt 	The prompt sub-element is an atom:text construct that specifies the prompt text displayed near the spelling suggestion.
/feed/spelling:spelling/link 	The link sub-element of spelling is an Atom Link element whose link targets search requests for the suggested spell-corrected query.
/feed/spelling:spelling/link[@rel] 	The rel attribute value will be "spelling".
/feed/openSearch:totalResults
	
Total number of results for submitted query.
/feed/openSearch:Query 	Contains information about the query that was submitted by the user.
/feed/openSearch:Query[@role] 	The role attribute value will be "request".
/feed/openSearch:Query[@searchTerms] 	Represents the user submitted query terms.
/feed/openSearch:Query/ibmsc:constraint 	Represents a constraint set in the request
/feed/openSearch:Query/ibmsc:constraint[@type] 	The constraint type: "category", "range" or "field"
/feed/openSearch:Query/ibmsc:constraint[@id] 	
The constraint id of field and range constraints
/feed/openSearch:Query/ibmsc:constraint[@datatype] 	The data type of field and range constraints
/feed/openSearch:Query/ibmsc:constraint[@label] 	
The label of field and range constraints
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue 	The constraint value
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@id] 	The value id for "category" and "field" constraints
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@label] 	The label of the constraint value.
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@lowerInclusive ] 	Lower inclusive value for range constraints.
/feed/openSearch:Query/ibmsc:constraint/ibmsc:constraintValue[@upperInclusive ] 	Upper inclusive value for range constraints.
/feed/openSearch:itemsPerPage
	
Number of search results returned in this feed.
/feed/entry
	
Encompasses the information for a single search result.
/feed/entry/category
	
Conveys information about a category (often corresponding to a facet) associated with an entry. Refer to Categories in Search API responses for more information.
/feed/entry/category@term
	
A string that identifies the category to which the entry belongs. Refer to Categories in Search API responses for more information.
/feed/entry/category@scheme 	An IRI that identifies a categorization scheme. Refer to Categories in Search API responses for more information.
/feed/entry/title
	Text construct that conveys a human-readable title for an entry.
/feed/entry/title[@type] 	Indicates whether the text construct is "text", "html" or "xhtml". Text construct is "text" if not otherwise specified.
/feed/entry/link
	
Defines a reference to the search result resource.
/feed/entry/link[@rel]
	
Indicates the link relation type. If not present, the link relation type is "alternate".
/feed/entry/link[@href]
	
URI link to document
/feed/entry/link[@type]
	
Content type of the URI document link is an advisory media type.
/feed/entry/relevance:score
	Indicates a relative assessment of relevance for a particular search result with respect to the search query.
/feed/entry/updated
	
Last modified date for the document. The value will conform to the date-time production in RFC3339.
/feed/entry/id
	
Unique identifier of the document.
/feed/entry/summary
	Text construct that conveys a short summary, abstract, or excerpt of an entry.
/feed/entry/summary[@type] 	Indicates whether the text construct is "text", "html" or "xhtml". Text construct is "text" if not otherwise specified.
/feed/entry/author
	A person construct that indicates the author of the entry or feed.
/feed/entry/author/name
	
Human-readable name for the person.
/feed/entry/author/snx:userid
	
Identifier associated with the person.
/feed/entry/author/email
	
The person email address. This may not be returned as part of the feed depending on the IBM Connections configuration settings.
/feed/entry/author/snx:userState 	The user state associated with the person. Possible values are active and inactive.
/feed/entry/contributor 	A person construct that indicates a person who contributed to the entry.
/feed/entry/contributor/name 	Human-readable name for the person.
/feed/entry/contributor/snx:userid 	Identifier associated with the person.
/feed/entry/contributor/email 	The person email address. This may not be returned as part of the feed depending on the IBM Connections configuration settings.
/feed/entry/contributor/snx:userState 	The user state associated with the person. Possible values are active and inactive.
/feed/entry/ibmsc:field
	
This element is used to represent the name and value of a field of a document. The id attribute represents the name of the field. The body of the element represents the value of the field. Additional fields will be included in the search result response if specified through the includeField parameter.
/feed/entry/ibmsc:entity_evidence 	Refer to Evidence Element for more information.
/feed/entry/snx:communityUuid 	The unique identifier of the community this document is associated with.
/feed/entry/snx:rank 	Number of likes for the entry. The scheme attribute will be "http://www.ibm.com/xmlns/prod/sn/recommendation".
/feed/ibmsc:facets
	
Refer to Facets for more information.
  	 

    The namespace in the table above is "http://www.w3.org/2005/Atom" unless otherwise specified.
    The openSearch identifier is used above to refer to the namespace "http://a9.com/-/spec/opensearch/1.1".
    The relevance identifier is used above to refer to the namespace "http://a9.com/-/opensearch/extensions/relevance/1.0/".
    The ibmsc identifier is used above to refer to the namespace "http://www.ibm.com/search/content/2010".
    The snx identifier is used above to refer to the namespace "http://www.ibm.com/xmlns/prod/sn".
    The spelling identifer is used above to refer to the namespace "http://a9.com/-/opensearch/extensions/spelling/1.0/".
To search for all content across IBM Connections that contains the text Red:
> GET /search/atom/search/results?query=%22Red%22 HTTP/1.1

	> Host: example.enterprise.com:9443

	> Accept: */*


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

	<feed

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

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

	xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/"

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

	<title>"Red"</title>

	<link

	href="https://example.org:9443/search/atom/search/

	results?query=%22Red%22" rel="self" />

	<updated>2008-10-07T22:58:03Z</updated>

	<id>https://example.org:9443/search/atom/search/

	results?query=%22Red%22</id>

	<openSearch:totalResults>2309</openSearch:totalResults>

	<openSearch:itemsPerPage>10</openSearch:itemsPerPage>

	<openSearch:startIndex>1</openSearch:startIndex>

	<link

	href="http://search-server:9080/search/atom/search/facets/

	source?query=%22Red%22" rel="related" />

	<link href="http://search-server:9080/search/atom/search/facets/

	tags?query=%22Red%22" rel="related" />

	<link href="http://search-server:9080/search/atom/search/facets/

	people?query=%22Red%22" rel="related" />

	<link href="http://search-server:9080/search/atom/search/

	results?query=&quot;Red&quot;&page=2" rel="next" />

	<link href="http://search-server:9080/search/atom/search/

	results?query=&quot;Red&quot;&page=230" rel="last" />

	<openSearch:Query role="request" searchTerms=""Red"" />

	<entry>

	<title>Title</title>

	<link href="http://example.org/" />

	<id>urn:uri:1547735</id>

	<updated>2007-12-22T13:26:40+00: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" />

	<category term="red" />

	<category term="sports" />

	<category term="baseball" />

	<author>

	<name>John E. Smith</name>

	<snx:userid>177crjc0-8f0a-1028-8f0c-db93503b53t4</snx:userid>

	</author>

	<summary type="html" />

	<relevance:score>5.4105196</relevance:score>

	</entry>

	...

	</feed>

Kevin Joyce commented on Mar 16, 2016

Re: Search API