searchService

Provides the ability to search for content.

Method	Description
countQuickMessageSearchResultsByCommunityID	Returns the number of possible results for the specified query.
countQuickSearchResults	Returns the number of possible results for the specified query.
countSearchResults	Returns the number of possible results for the specified query.
countSearchResultsByCommunityID	Returns the number of possible results for the specified query by category.
quickMessageSearchByCommunityID	Provides the ability to do quick search queries based on the provided string.
quickSearch	Provides the ability to do quick search queries based on the provided string.
search	Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.
searchByCommunities	Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

countQuickMessageSearchResultsByCommunityID

Returns the number of possible results for the specified query.

GET http://domain:port/application_context/rpc/rest/searchService/communitySearchCount/{communityID}/{query}/{contentTypes}

Response

Type	Description
xs:int	The number of search results.

Response Template

<countQuickMessageSearchResultsByCommunityIDResponse> 
    <return>xs:int</return>
</countQuickMessageSearchResultsByCommunityIDResponse>

Errors

Error	When Returned
CommunityNotFound	Thrown if the community does not exist.
Unauthorized	if not allowed to view the community

countQuickSearchResults

Returns the number of possible results for the specified query.

POST http://domain:port/application_context/rpc/rest/searchService/quickSearchCount

Arguments

Name	Type	Description
query	xs:string	The query to find the number of results for.
contentTypes	xs:int	an array of jive content types

Arguments Template

<countQuickSearchResults> 
    <query>xs:string</query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countQuickSearchResults>

Response

Type	Description
xs:int	The number of search results.

Response Template

<countQuickSearchResultsResponse> 
    <return>xs:int</return>
</countQuickSearchResultsResponse>

countSearchResults

Returns the number of possible results for the specified query.

POST http://domain:port/application_context/rpc/rest/searchService/searchCount

Arguments

Name	Type	Description
query	Contents of Query	The query to find the number of results for.
contentTypes	xs:int	an array of jive content types

Arguments Template

<countSearchResults> 
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countSearchResults>

Response

Type	Description
xs:int	The number of search results.

Response Template

<countSearchResultsResponse> 
    <return>xs:int</return>
</countSearchResultsResponse>

countSearchResultsByCommunityID

Returns the number of possible results for the specified query by category.

POST http://domain:port/application_context/rpc/rest/searchService/communitySearchCount

Arguments

Name	Type	Description
communityID	xs:long	The id of the category.
query	Contents of Query	The query to find the number of results for.
contentTypes	xs:int	an array of jive content types

Arguments Template

<countSearchResultsByCommunityID> 
    <communityID>xs:long</communityID>
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countSearchResultsByCommunityID>

Response

Type	Description
xs:int	The number of search results.

Response Template

<countSearchResultsByCommunityIDResponse> 
    <return>xs:int</return>
</countSearchResultsByCommunityIDResponse>

Errors

Error	When Returned
CommunityNotFound	Thrown if the community does not exist.
Unauthorized	if not allowed to view the community

quickMessageSearchByCommunityID

Provides the ability to do quick search queries based on the provided string.

GET http://domain:port/application_context/rpc/rest/searchService/communitySearch/{communityID}/{query}/{contentTypes}/{startIndex}/{numResults}

Response

Type	Description
List of JiveObject	A list of objects that match the search criteria.

Response Template

<quickMessageSearchByCommunityIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</quickMessageSearchByCommunityIDResponse>

Errors

Error	When Returned
CommunityNotFound	Thrown if the community specified does not exist.
Unauthorized	if not allowed to view the community

quickSearch

Provides the ability to do quick search queries based on the provided string.

POST http://domain:port/application_context/rpc/rest/searchService/quickSearch

Arguments

Name	Type	Description
query	xs:string	The query string.
contentTypes	xs:int	an array of jive content types
startIndex	xs:int	Starting point of results to grab.
numResults	xs:int	Ending point of results to grab. @return An array of message IDs.

Arguments Template

<quickSearch> 
    <query>xs:string</query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</quickSearch>

Response

Type	Description
List of JiveObject	A list of objects that match the search criteria.

Response Template

<quickSearchResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</quickSearchResponse>

search

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.

POST http://domain:port/application_context/rpc/rest/searchService/search

Arguments

Name	Type	Description
query	Contents of Query	The query objects.
contentTypes	xs:int	an array of jive content types
startIndex	xs:int	Starting point of results to grab.
numResults	xs:int	Ending point of results to grab.

Arguments Template

<search> 
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</search>

Response

Type	Description
List of JiveObject	An array of message IDs.

Response Template

<searchResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</searchResponse>

searchByCommunities

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

POST http://domain:port/application_context/rpc/rest/searchService/communitySearch

Arguments

Name	Type	Description
communityID	xs:long	The id of the category
query	Contents of Query	The query objects.
contentTypes	xs:int	an array of jive content types
startIndex	xs:int	Starting point of results to grab.
numResults	xs:int	Ending point of results to grab. @return An array of message IDs.

Arguments Template

<searchByCommunities> 
    <communityID>xs:long</communityID>
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</searchByCommunities>

Response

Type	Description
List of JiveObject	A list of objects that match the search criteria.

Response Template

<searchByCommunitiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</searchByCommunitiesResponse>

Errors

Error	When Returned
CommunityNotFound	Thrown if the category does not exist