The InService Search web service enables you to perform full text searches, information element searches, and to retrieve a list of suggested search terms. The Search web service’s interfaces use OData specifications to receive the input from the clients.
| Class | Method | Description |
|---|---|---|
| com.ptc.sc.sce.services.SCESearchService | all | This is the standard implementation of the Search service(com.ptc.sc.servicecommon.SearchService) that uses E3C as a search engine. This can be extended or replaced completely to make use of a different search engine. |
| com.ptc.sc.services.plugins.SearchInputFormatter | all | This is the interface service (used by com.ptc.sc.servicecommon.SearchService) to format the search input strings. Multiple formatters are provided for different types of inputs OOTB such as keyword (SearchKeyWordFormatter), MultiValueSearchInputFormatter e.t.c. The custom formatters can be implemented as needed and configured. |
| facets.xml | all | The configuration file to support the facets to be displayed. This includes the facets to be displayed, icons, whether a preview is enabled for certain types of facets. The facets.xml can be customized, overridden based on custom requirements. |
| searchConfig.xml | all | The configuration file to support search configurations such as searchTypes, searchQueryParmeters, Search sortorder types e.t.c. The configuration file can be customized, overridden based on custom requirements. |
| Name | Description | Version |
|---|---|---|
| $filter | This OData parameter specifies the search criteria. You can provide multiple parameters as search criteria using the $filter query parameter. For example: $filter=infotype eq 'partslist,information' and searchtype eq 'partnumber' and keyword eq 'piston' | current |
| $orderby | This OData parameter specifies how to sort the search results. You can specify multiple sort levels with a comma separated list of values. For example: $orderby=TTILE asc,ID desc. | current |
| $top | This OData parameter specifies the number of search results to be returned to the client. The default value for the $top parameter is configured using InService system property com.ptc.sc.servicecommon.StandardSystemPropertyService.globalDefaultPageSize. If $top value is not passed, the default value might be used to specify the number of results to display per page. | current |
| $skip | This OData parameter specifies the number of the result from which to start. If the $skip value is not passed, the default value of 0 is used. | current |
| $select | This OData parameter specifies the fields to include in the search results. The fields are provided as comma separated values. For example: $select=id,title,desc. | current |
| $expand | This OData parameter specifies expanded search information such as teaser and facets. You can provide multiple expand values as comma separated values. For example: $expand=teaser,facets. | current |
| effectivity | This InService parameter specifies effectivity filtering. The filtering criteria are included in this parameter. Currently, you can use contextId, SnStart and SnEnd values as part of the effectivity expression. For example: effectivity=ContextId eq '3C-Product:NPF0000000004:PHToc:NSM00006943' and SnStart ge '1' and SnEnd le '124287' | current |
| facetfilter | This InService parameter is used to post filter the search results.you can provide multiple parameters as part of facetfilter expression. For example: facetfilter=infotype eq 'partslist,information' and excludedfacets eq 'infoType' | current |
| querystring | This InService parameter specifies the search criteria and filtering information to use for the search.The needed information is provided in a concatenated string. For example: querystring=q=oil&df=keywords_en&qf=keywords_en&hl.fl=teaser&sort=score desc&facet.field={!ex=tagForinfoType}infoType&facet=true&facet.mincount=1&facet.field=nodePathText&f.nodePathText.facet.sort=index&f.nodePathText.facet.limit=-1&computeIcons=true | 10.1 |
The following resources are applicable:
Perform a full text search using the passed parameters.
Deprecated. Use InService 6.0 version instead.
| name | type | description | default |
|---|---|---|---|
| $filter | query | OData expression that represents a query string. | n/a |
| $orderby | query | Not currently used by the search. | n/a |
| $select | query | A list of the fields that will be returned with the results. | n/a |
| $skip | query | Used for paging, the number of the result to start from. | n/a |
| $top | query | Used for paging, the number of the result to return to. | n/a |
| querystring | query | A list of search parameters that are to be included in the query. | n/a |
| code | condition |
|---|---|
| 404 | returned if search results can not be generated for the context |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchList (JSON) |
Perform a search for suggested words and auto complete.
Deprecated. Use InService 6.0 version instead.
| name | type | description | default |
|---|---|---|---|
| $filter | query | OData expression that represents a query string. | n/a |
| $orderby | query | Not currently used by the search. | n/a |
| $select | query | A list of the fields that will be returned with the results. | n/a |
| $skip | query | Used for paging, the number of the result to start from. | n/a |
| $top | query | Used for paging, the number of the result to return to. | n/a |
| querystring | query | A list of search parameters that are to be included in the query. | n/a |
| code | condition |
|---|---|
| 404 | Returned if suggestions can not be generated for the context. |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchValueList (JSON) |
Use the Search web service’s searchtypes endpoint to return the valid search types to be displayed on the advanced search page. These values are used to populate the Search Type drop-down menu on the Advanced Search page. The search types are maintained in the searchConfig.xml
| code | condition |
|---|---|
| 404 | returned if no search types are found |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | array of object (JSON) |
Use the Search web service’s queryconfig endpoint to return a QueryConfig XML document.
Deprecated. Use /config/{configName}
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | object (JSON) |
Use the Search web service’s sortingordertypes endpoint to return the valid SortingOrder types to be displayed on the search results page. These values are used to populate the Sort by drop-down menu on the search results page.The search sort order types are maintained in the searchConfig.xml
| code | condition |
|---|---|
| 404 | returned if no sorting order types are found |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | array of object (JSON) |
Use the Search web service’s find endpoint to search for a keyword and return the keyword occurrences per page mappings found in the search results. If the keyword is not found in the search results, an empty list is returned.
| name | type | description | default |
|---|---|---|---|
| $filter | query | OData expression that represents a query string. | n/a |
| $orderby | query | Currently not used. | n/a |
| $select | query | A list of the fields to be returned with the results. | n/a |
| $skip | query | The number of the result from which to start. | n/a |
| $top | query | The number of the result to return per page. | n/a |
| attributesToSearch | query | A comma separated list of attributes to be matched against the keyword. | n/a |
| keyWord | query | The keyword that needs to be matched against the attributes. | n/a |
| pageSize | query | The number of search results per page. | n/a |
| querystring | query | A list of search parameters to be included in the query. | n/a |
| code | condition |
|---|---|
| 404 | Returned if the search service did not return any results and the keyword could not be searched for in the results. |
| media type | data type |
|---|---|
| application/vnd.ptc.sc+json | array of object (JSON) |
Use the Search web service’s WebUrl endpoint to produce a URL that generates the same search result page as that generated by Global Search or Advanced Search operations in the InService user interface. The generated URL can be used in a web browser, embedded as a page in another web page, or used as a link in a document or email. The parameters used by the web service to generate the URL follow the OData standardized syntax.
The following parameters are used by the WebUrl endpoint:
| name | type | description | default | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| $expand | query | Currently not used. | n/a | ||||||||||
| $filter | query | A list of search parameters.
This parameter holds a list of search parameters used for searching InService data. Search parameters follow the Odata syntax. The following search parameters are currently supported:
|
n/a | ||||||||||
| $orderby | query | Sort attribute for the search results. The value passed must be a configured sort attribute. Sort order can be 'asc' for ascending or 'desc' for descending.
For example: $orderby=TITLE asc. default value: Default sort order is 'asc', unless a different sort attribute is flagged as default in the search configuration. |
n/a | ||||||||||
| $select | query | Currently not used. | n/a | ||||||||||
| $skip | query | Number of result rows to skip before retrieving the number of rows specified for $top parameter. default value: 0 |
n/a | ||||||||||
| $top | query | Number of result rows required after skipping the number specified in the $skip parameter. default value: Defined in the InService 'Search results per page count' preference. |
n/a | ||||||||||
| effectivity | query | Custom parameter used by InService for effectivity filter criteria. Standard effectivity such as 'snStart', 'snEnd', 'dateStart', 'dateEnd', a custom effectivity name, or other valid options can be used. | n/a |
| code | condition |
|---|---|
| 200 | Returned if request was successfully executed. |
| 400 | Returned if the keyword was not specified in the <$filter> and the keyword could not be searched for in the results. |
| 415 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCValue (JSON) |
Use the Search web service’s text endpoint to perform a full text search using the passed parameters.
| name | type | description | default |
|---|---|---|---|
| $expand | query | This OData parameter specifies expanded search information such as teaser and facets. You can provide multiple expand values as comma separated values.Currently the teaser and facets are returned by default. | n/a |
| $filter | query | This OData parameter specifies the search criteria. You can provide multiple parameters as search criteria using the $filter query parameter.
For example:$filter= infotype eq 'partsList' and searchcontext eq '3C-Product:NPF0000000004:PHToc:NSM00006943' and keyword eq 'PISTON'.
The following filter parameters are supported: Typically the searchQueryParameters defined in searchConfig.xml can be passed as filter parameters
|
n/a |
| $orderby | query | This OData parameter specifies how to sort the search results. You can specify multiple sort levels with a comma separated list of values.For example: $orderdy=TITLE asc,ID desc. the order type parameters are configured in searchConfig.xml. | n/a |
| $select | query | This OData parameter specifies the fields to include in the search results. The fields are provided as comma separated values.For example; $select=id,infotype, title.
the select values are configured in searchQueryCOnfig.xml and searchConfig.xml
Supported $select values are id, infotype and title. |
n/a |
| $skip | query | This OData parameter specifies the number of the result from which to start.(For example : $skip = 20) | n/a |
| $top | query | This OData parameter specifies the number of search results to be returned to the client.(For example: $top = 10) | n/a |
| effectivity | query | This InService parameter specifies effectivity filtering. The filtering criteria are included in this parameter.
For example; effectivity=ContextId eq '3C-Product:NPF0000000004:PHToc:NSM00006943' and SnStart ge '1' and SnEnd le '124287'.
The following effectivity parameters are supported:
|
n/a |
| facetfilter | query | This InService parameter specifies the information type or facet filtering on the current search results..
The following facefilter parameters are currently supported supported:
|
n/a |
| code | condition |
|---|---|
| 200 | Returned if the request is successful. |
| 400 | Returned if the request provided is invalid. |
| 404 | Returned if search results can not be generated for the context |
| 415 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchList (JSON) |
Use the Search web service's suggestions endpoint to provide a list of search suggestions based on the provided parameters.
| name | type | description | default |
|---|---|---|---|
| $expand | query | This OData parameter specifies expanded search information such as teaser and facets.Currently this parameter is not used by suggestions endpoint. | n/a |
| $filter | query | This OData parameter specifies the search criteria. You can provide multiple parameters as search criteria using the $filter query parameter.
(for example:$filter=infotype eq 'PH' and keyword eq 'ROD' and searchprefix eq 'PISTON' and searchprecedingtest eq 'EN').
The following values are supported:
The following values are supported:
|
n/a |
| $orderby | query | This OData parameter specifies how to sort the search results.Currently this parameter is not used by suggestions endpoint. | n/a |
| $select | query | This OData parameter specifies the fields to include in the search results. The fields are provided as comma separated values. For example: $select= id,title,desc.
The following select values are supported::
|
n/a |
| $skip | query | This OData parameter specifies the number of the result from which to start.Currently this parameter is not used by the suggestions endpoint. | n/a |
| $top | query | This OData parameter specifies the number of search results to be returned to the client.Currently this parameter is not used by the suggestions endpoint. | n/a |
| effectivity | query | This InService parameter specifies effectivity filtering.Currently this parameter is not used by suggestions endpoint. | n/a |
| facetfilter | query | This InService parameter specifies the information type or facet filtering. Currently, this parameter is not used by the suggestions endpoint. | n/a |
| code | condition |
|---|---|
| 200 | Returned if the request is successful. |
| 400 | Returned if the request provided is invalid. |
| 404 | Returned if search results can not be generated for the context |
| 415 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchValueList (JSON) |
Use the Search web service’s orientationpaths end point to display all the valid location paths for a given element. This is mainly used when navigating from search results and to support navigation for IE to IE links. Apart from the below parameters the effectivity and collectionId are also needed for successfully identify the locations for the element. effectivity The effectivity expression that needs to be used for filtering the data. collectionId The collection where this item is located
| name | type | description | default |
|---|---|---|---|
| $filter | query | OData expression that represents a query string. The typical parameters include searchcontext,radarpath,preferredIS e.t.c
The following filter parameters are supported:
|
n/a |
| $orderby | query | Currently the parameter is not supported. The current ordering is automatically based on the navigation path such as (PHF> PHM >ISRoot> ISNode e.t.c) | n/a |
| $skip | query | The number of the result from which to start. | n/a |
| $top | query | The number of the result to return per page. | n/a |
| elementId | query | The element for which the orientation paths need to be retrieved. | n/a |
| code | condition |
|---|---|
| 404 | Returned if the search service did not return any results |
| 415 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchList (JSON) |
Use the Search web service’s orientationpaths/find endpoint to search for a location
Deprecated. UI find is used OOTB instead of endpoint/p>
| name | type | description | default |
|---|---|---|---|
| $expand | query | n/a | |
| $skip | query | n/a | |
| $top | query | n/a | |
| attributesToSearch | query | n/a | |
| effectivity | query | n/a | |
| elementId | query | n/a | |
| keyWord | query | n/a | |
| pageSize | query | n/a |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | array of object (JSON) |
Gets a count of new and updated InService items loaded into the repository. Items can be searched
for load date ranges or a particular load date.
See the /search/text endpoint documentation on the parameters used and configuration details.
Supported API: true
Extendable: true
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCValue (JSON) |
Gets status of coreServer whether its running or not.
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCValue (JSON) |
Use InService getSearchResultsURL endpoint to produce an URL that generates the same search result page as that generated by advanced Search operations in the InService user interface. The generated URL can be used by connector to navigate to the InService web browser. The parameters used by the web service to generate the URL follow the Data standardized syntax.
Produces a URL viewer to InService Advance Search Page.
The following parameters are used by the getSearchResultsURL endpoint:
| name | type | description | default |
|---|---|---|---|
| infoType | query | Optional parameter indicating the search will include only the information types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available info types. For example:searchText=pdf&infoType='kit,Media,partsList,Information' | n/a |
| kitType | query | Optional parameter indicating the search will include only the kit types listed. Supported only when partSearch is set to true and sn and product Name are not specify. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available kit types. For example:searchText=pdf&kitType='Hardware' | n/a |
| partInfoType | query | Optional parameter indicating the search will include only the partInfo types listed.
Supported only when partSearch is set to true and sn and product Name are not specify.
Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available part info types.
For example: searchText=pdf&partInfotype='PART_TYPE_KIT' |
n/a |
| partSearch | query | The parameter that allow to search for content or search part. It is false by default, can be set to true to run the search for part\kit. | n/a |
| partType | query | Optional parameter indicating the search will include only the part types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available part types. For example:searchText=pdf&partType='Hardware' | n/a |
| productName | query | Exact Match of the name of a product hierarchy node. | n/a |
| pubtype | query | Optional parameter indicating the search will include only the publication types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available pub types. For example:searchText=pdf&pubtype='Dynamic Document,General' | n/a |
| searchText | query | The string that will be submitted for full text search, in URL keyword=searchText.
SearchText that holds the keyword.
List of search parameters used for searching InService data. Search parameters follow the Odata syntax. The following search parameters are currently supported: |
n/a |
| searchType | query | Optional parameter indicating the search will include only the types listed. | |
| searchType | Optional parameter indicating the search should be only for the types specified.
The following search types are supported when partSearch=true:
The following search types are supported when partSearch=false or default
|
n/a | |
| skip | query | Number of result rows to skip before retrieving the number of rows specified in $top parameter. default value: 0 |
n/a |
| sn | query | The Serial Number to identify the asset. | n/a |
| top | query | The number of the result to return per page. ps= top default value: Defined in the InService 'Search results per page count' preference. | n/a |
| code | condition |
|---|---|
| 200 | Returned if the request is successful. |
| 400 | Returned if the request provided is invalid. |
| 406 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchList (JSON) |
Use InService Search getSearchResults endpoint to produce a search results of the IE elements and generates the URL to search result page. The generated URL can be used in by connector to navigate to the InService web browser. The parameters used by the web service to generate the search results and URL follow the Data standardized syntax.
Produces a actual search results and URL viewer to InService Advance Search Page.
The following parameters are used by the getSearchResults endpoint:
| name | type | description | default |
|---|---|---|---|
| infoType | query | Optional parameter indicating the search will include only the information types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available info types. For example:searchText=pdf&infoType='Information,kit' | n/a |
| kitType | query | Optional parameter indicating the search will include only the kit types listed. Supported only when partSearch is set to true and sn and product Name are not specify. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available kit types. For example:searchText=pdf&kitType='Hardware' | n/a |
| partInfoType | query | Optional parameter indicating the search will include only the partInfo types listed.
Supported only when partSearch is set to true and sn and product Name are not specify.
Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available part info types.
For example: searchText=pdf&partInfotype='PART_TYPE_KIT' |
n/a |
| partSearch | query | The parameter that allow to search for content or search part. It is false by default, can be set to true to run the search for part\kit. | n/a |
| partType | query | Optional parameter indicating the search will include only the part types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available part types. For example:searchText=pdf&partType='Hardware' | n/a |
| productName | query | Exact Match of the name of a product hierarchy node. | n/a |
| pubtype | query | Optional parameter indicating the search will include only the publication types listed. Please refer to PTC ervigistics InService™ Publishing and Loading Guide for information how to find all available pub types. For example:searchText=pdf&pubtype='Document' | n/a |
| searchText | query | The string that will be submitted for full text search, in URL keyword=searchText.
SearchText that holds the keyword.
InfoTpe and pubtype parameters used for searching for IEs in InService data. Search parameters follow the Odata syntax. The following search parameters are currently supported: |
n/a |
| searchType | query | Optional parameter indicating the search will include only the types specified. | |
| searchType | Optional parameter indicating the search should be only for the types specified.
The following search types are supported when partSearch=true:
The following search types are supported when partSearch=false or default
|
n/a | |
| skip | query | Number of result rows to skip before retrieving the number of rows specified for $top parameter. default value: 0 |
n/a |
| sn | query | The Serial Number to identify the asset. | n/a |
| top | query | The number of the result to return per page. ps= top default value: Defined in the InService 'Search results per page count' preference. |
n/a |
| code | condition |
|---|---|
| 200 | Returned if the request is successful. |
| 400 | Returned if the request provided is invalid. |
| 406 | Returned if the Accept header passed is not application/vnd.ptc.scsearch+json;version=2 |
| media type | data type |
|---|---|
| application/vnd.ptc.scsearch+json | SCSearchList (JSON) |