Search API
| Action | Endpoint |
|---|---|
| Fetch Search Results | POST/search/{tenantLocator}/search |
| Fetch Additional Search Results By Token | GET/search/{tenantLocator}/search |
| Fetch Search Stats | POST/search/{tenantLocator}/search/searchStats |
| Fetch Fields Mapping | GET/search/{tenantLocator}/search/fieldsMapping |
| Fetch Ignored Fields | GET/search/{tenantLocator}/search/ignoredFields |
Data Search
In addition to the read permission, you will need the policies.list, quotes.list, or accounts.list permission to be able to execute a search on the respective entity type.
Fetch Search Results
Fetch Search Results
fetchSearchResultsPOST
/search/{tenantLocator}/searchParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
offset | query | integer? | No | |
count | query | integer? | No |
Fetch Additional Search Results By Token
Fetch Additional Search Results By Token
fetchAdditionalSearchResultsByTokenGET
/search/{tenantLocator}/searchParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
offset | query | integer? | No | |
count | query | integer? | No | |
searchToken | query | string | Yes | The token returned from the initial search |
Response:
SearchServiceResponseSecurity Group:
searchPermission:
readFetch Search Stats
Fetch Search Stats
fetchSearchStatsPOST
/search/{tenantLocator}/search/searchStatsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes |
Fetch Fields Mapping
Fetch Fields Mapping
fetchFieldsMappingGET
/search/{tenantLocator}/search/fieldsMappingParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
request | query | FieldsRequest | Yes |
Response:
FieldsMappingResponse[]Security Group:
searchPermission:
readFetch Ignored Fields
Fetch Ignored Fields
fetchIgnoredFieldsGET
/search/{tenantLocator}/search/ignoredFieldsParameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantLocator | path | uuid | Yes | |
request | query | FieldsRequest | Yes |
Response:
FieldsMappingResponse[]Security Group:
searchPermission:
readSearch Request and Response Objects
SearchRequest
Required properties
| Property | Type | Description |
|---|---|---|
searchEntityType | Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation | |
searchString | string | |
sortOrder | Enum Asc | Desc | |
fields | string[] | |
searchTerms | SearchTermRequest[] |
Optional properties
| Property | Type | Description |
|---|---|---|
endCreationTime | datetime? | |
sortField | string? | |
startCreationTime | datetime? |
SearchTermRequest
Required properties
| Property | Type | Description |
|---|---|---|
fieldName | string | |
absolute | Enum none | required | excluded | |
match | Enum fuzzy | exact | startsWith | lessThan | greaterThan | |
searchTerm | string |
SearchServiceResponse
Required properties
| Property | Type | Description |
|---|---|---|
count | integer | |
offset | integer | |
searchToken | string | |
results | SearchResultResponse[] |
SearchResultResponse
Required properties
| Property | Type | Description |
|---|---|---|
accountLocator | string | |
configVersionLocator | string | |
searchEntityLocator | ulid | |
productName | string | |
score | number | |
searchEntityType | Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation | |
highlights | string[] | |
searchSummary | map<string, object> |
SearchStatsResponse
Required properties
| Property | Type | Description |
|---|---|---|
searchToken | string | |
results | SearchStatsResult[] |
SearchStatsResult
Required properties
| Property | Type | Description |
|---|---|---|
recordCount | integer | |
searchEntityType | Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation |
FieldsRequest
Required properties
| Property | Type | Description |
|---|---|---|
searchEntityType | Enum unspecified | account | quote | policy | fnol | contact | diary | payment | task | userAssociation |
FieldsMappingResponse
Required properties
| Property | Type | Description |
|---|---|---|
index | string | |
fields | Field[] |
Field
Required properties
| Property | Type | Description |
|---|---|---|
name | string | |
type | Enum TEXT | DATE | OTHER |