Enterprise Search API
Endpoint Index
| Action | Endpoint |
|---|---|
| Execute Search | POST /search |
| Search Result Pagination | GET /search/{searchToken}/{pageNumber} |
Details
POST /search| Name | Position | Type | Required |
|---|---|---|---|
| searchRequest | body | SearchRequest | required |
SearchResponseoptionalincludeReplaced booleanproducts [string]returnType stringsearchString stringsearchTerms [SearchTermRequest]
Note
Either searchString or searchTerms must be provided. See the search syntax section for details on searchString syntax.
requiredresults [SearchResultResponse]optionalpageNumber integersearchToken string
Note
No search results is signified by an empty results array.
requiredpolicyholderLocator stringscore numbertype stringoptionalpolicyLocator stringclaimLocator stringpaymentDisplayId stringpaymentLocator stringpremiumReportLocator stringquoteLocator stringsearchSummary [SearchSummaryItemResponse]subclaimLocator string
requiredfieldName stringfieldType stringfieldValue [string]
All SearchSummaryItemResponse values will be returned as strings, regardless of configured type; for example, timestamps will be returned as numeric strings. Multi-value selects will have more than one entry for the fieldValue array.
Items in the searchSummary will be returned in the same relative order as the configured searchSummary list, but may be preceded by default SearchSummaryItemResponse entries, depending on the returned entity type.
requiredsearchTerm stringoptionalfieldName stringabsolute stringmatch string
The
SearchTermRequestpropertyabsolutecan have the following values:none(default)requiredexcluded
The
SearchTermRequestpropertymatchcan have the following values:fuzzy(default)exactstartsWith
GET /search/{searchToken}/{pageNumber}| Name | Position | Type | Required |
|---|---|---|---|
| pageNumber | path | string | required |
| searchToken | path | string | required |
SearchResponseSearch String Examples
Search Intent |
Search String |
|---|---|
Search all fields for red |
|
Search all fields for red |
|
Search all fields for excluding red |
|
Search all fields for red or green |
|
Search all fields for red and green |
|
Search all fields for (red or green) and blue |
|
Search all fields for exact match “dark red” and green |
|
Search “door” field for exact match “dark red” and all fields for green |
|
Search all fields for dark or red or exact match blue |
|
Search all fields for exact match “dark red” or exact match “dark green” |
|
Search “door” for red or “hood” for green |
|
Search “front door” field for “dark red” and field “hood” that starts with “blue” |
|