SearchService
Web services used to perform searches of bundles and components.
Endpoint Metadata
- Namespace: http://opencase.extend.com/webservices/search
- Endpoint Name: SearchWebService
- Endpoint Address: http(s)://{VMS URL}/ContentManager/webservices/search-service
The following methods are available on this endpoint:
Retrieves a list with all the bundle types.
Return Value
Faults
name |
description |
SearchWebserviceFault |
If the bundle types cannot be retrieved. |
Retrieves a list with all the common entity types.
Return Value
Faults
name |
description |
SearchWebserviceFault |
If the common entity types cannot be retrieved. |
Retrieves a list with all the component types.
Return Value
Faults
name |
description |
SearchWebserviceFault |
If the component types cannot be retrieved. |
Finds a bundle type with a specific name.
Input Parameters
name |
type |
description |
bundleTypeName |
string |
The name of the bundle type to find. Must not be null. |
Return Value
type |
description |
BundleType
|
A BundleType value or null if no match is found. |
Faults
name |
description |
SearchWebserviceFault |
If any error has prevented the bundle type from being retrieved. |
Retrieves bundle type label for specific language string.
Input Parameters
name |
type |
description |
resourceKey |
string |
the bundle type key for which label search |
language |
string |
the language of the bundle type label which will find |
Return Value
type |
description |
string |
localized label for current bundle type |
Faults
name |
description |
SearchWebserviceFault |
if any error occurs while performing the search. |
Retrieves a list with the BundleTypeDTO.
Return Value
Faults
name |
description |
SearchWebserviceFault |
If the bundle types cannot be retrieved. |
Finds a common entity type with a specific name.
Input Parameters
name |
type |
description |
commonEntityTypeName |
string |
(no documentation provided) |
Return Value
type |
description |
CommonEntityType
|
A CommonEntityType value or null if no match is found. |
Faults
name |
description |
SearchWebserviceFault |
If any error has prevented the common entity type from being retrieved. |
Finds a component type with a specific name.
Input Parameters
name |
type |
description |
componentTypeName |
string |
The name of the component type to find. Must not be null. |
Return Value
type |
description |
ComponentType
|
A ComponentType value or null if no match is found. |
Faults
name |
description |
SearchWebserviceFault |
If any error has prevented the component type from being retrieved. |
Performs a bundle search within a specified bundle type.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term. |
searchFilter |
BundleSearchFilter
|
(no documentation provided) |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
bundleSortField |
BundleSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned bundles. |
Return Value
type |
description |
SearchBundleResult
|
A SearchBundleResult object containing the search results within the specified bundle type. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a bundle search within a specified bundle type. This search excludes specified bundles from the search.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term. |
searchFilter |
BundleSearchFilter
|
A set of parameters to filter the search by. Must not be null. |
bundlesToExclude |
integer[] |
An array of primary keys of bundles that should not be searched returned in the search results. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
bundleSortField |
BundleSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned bundles. |
Return Value
type |
description |
SearchBundleResult
|
An AbstractSearchResult object containing the results of the search of the bundle type specified. |
Faults
name |
description |
SearchWebserviceFault |
If an error occurs while performing the search. |
Searches bundles using a text query.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term used to query the index. Wildcards (using an asterisk) may be used, but any specific restrictions are currently under discussion. |
searchFilter |
BundleSearchFilter
|
A set of parameters to filter the search by. Must not be null. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
bundleSortField |
BundleSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned bundles. |
Return Value
type |
description |
SearchBundleResult
|
An AbstractSearchResult object containing the search results. This object only contains bundles. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a bundle search within a specified bundle type. This search excludes all components that are within a specified bundle.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term. |
searchFilter |
BundleSearchFilter
|
A set of parameters to filter the search by. Must not be null. |
bundleItemContainingComponentsToExcludePk |
integer |
A bundle item containing other bundles that should be excluded from the search. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
bundleSortField |
BundleSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned bundles. |
Return Value
type |
description |
SearchBundleResult
|
An AbstractSearchResult object containing the results of the search of the bundle type specified. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a common entity search with a specified common entity type.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term. |
commonEntityTypePk |
integer |
The primary key of the common entity type to search for. If a null value is specified, no filtering will be applied. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
commonEntitySortField |
CommonEntitySortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
Return Value
type |
description |
SearchCommonEntityResult
|
A SearchCommonEntityResult object containing the results of the common entity search within a specified common entitytype. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Searches for components by using a text query with optional wildcards. The search spans across many component fields.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term that is compared against many component fields. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
Return Value
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within a specified component type (type derived from parent folder, that defined by bundleItemPk). This searchexcludes specified components from the search.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search string. |
bundleItemPk |
integer |
(no documentation provided) |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If null is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
Return Value
type |
description |
SearchComponentResult
|
A SearchComponentResult object containing the search results within the specified component type. These searchresults will exclude any specified components. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within a specified component type (type derived from parent folder, that defined by bundleItemPk). This searchexcludes specified components from the search.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search string. |
bundleItemPk |
integer |
(no documentation provided) |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If null is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
restrictionKey |
string |
(no documentation provided) |
Return Value
type |
description |
SearchComponentResult
|
A SearchComponentResult object containing the search results within the specified component type. These searchresults will exclude any specified components. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within one specific component type.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search term that is compared against many component fields. |
componentTypePk |
integer |
The primary key of a specific component type to limit the search to. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
Return Value
type |
description |
SearchComponentResult
|
An AbstractSearchResult object containing the search results within the specified component type. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within a specified component type. This search excludes specified components from the search.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search string. |
componentTypePk |
integer |
The primary key of the component type to limit the search to. |
excludeComponents |
integer[] |
An array of integers representing the primary keys of components to exclude from the search. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If null is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
Return Value
type |
description |
SearchComponentResult
|
A SearchComponentResult object containing the search results within the specified component type. These searchresults will exclude any specified components. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within a specified component type. This search excludes specified components from the search.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search string. |
componentTypePk |
integer |
The primary key of the component type to limit the search to. |
excludeComponents |
integer[] |
An array of integers representing the primary keys of components to exclude from the search. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If null is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
restrictionKey |
string |
(no documentation provided) |
Return Value
type |
description |
SearchComponentResult
|
A SearchComponentResult object containing the search results within the specified component type. These searchresults will exclude any specified components. |
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a component search within one specific component type. This search excludes all components within a specified bundle type.
Input Parameters
name |
type |
description |
searchTerm |
string |
The search string. |
bundleItemContainingComponentsToExcludePk |
integer |
The primary key of a bundleItem containing components to exclude from the search results. |
pagingInfo |
PagingInfo
|
Parameters specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
componentSortField |
ComponentSortField
|
The field to sort the search results by. If a null value is specified, no sorting will be applied. |
returnSimpleResults |
boolean |
A boolean value indicating whether the return values should be simple (scaled down) entities that include basic information or complete entities that contain all the details of the returned components. |
Return Value
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |
Performs a product search based on a search term and an optional search filter.
Input Parameters
name |
type |
description |
searchTerm |
string |
A mandatory search term. |
searchFilter |
productSearchFilter
|
An optional ProductSearchFilter object used to filter the search results. |
pagingInfo |
PagingInfo
|
Mandatory parameter specifying how paging will be implemented. Options allow results to be returned by pages or as a range of results based on their return order. The return order is numbered from 1 to n. |
productSortField |
productSortField
|
The field to sort the search results by. If a null is supplied default sorting will apply |
Return Value
Faults
name |
description |
SearchWebserviceFault |
If any error occurs while performing the search. |