Search API

Data Search

Important

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

fetchSearchResults

POST /search/{tenantLocator}/search

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional

Request:SearchRequest
Response:SearchServiceResponse
Security Group:search   Permission:read

Fetch Additional Search Results By Token

fetchAdditionalSearchResultsByToken

GET /search/{tenantLocator}/search

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
offset	query	int?	optional
count	query	int?	optional
searchToken	query	string	required

Response:SearchServiceResponse
Security Group:search   Permission:read

SearchRequest

required
searchEntityType Enum unspecified | account | quote | policy
searchString string
searchTerms SearchTermRequest[]

SearchTermRequest

required
fieldName string
absolute Enum none | required | excluded
match Enum fuzzy | exact | startsWith
searchTerm string

SearchServiceResponse

required
count int
offset int
searchToken string
results SearchResultResponse[]

SearchResultResponse

required
accountLocator string
searchEntityLocator locator
productName string
score number
searchEntityType Enum unspecified | account | quote | policy
highlights string[]
searchSummary map<string,object>

See Also

• Search Feature Guide