Search

SEARCH

CDAPI’s search feature offers intelligent free text search capabilities among the documents in the stores. Auto-completion and auto-correction are supported. In addition to simple term and phrase search the Lucene syntax is supported:

Features

Search Functions	Description
search for an exact word or phrase	Use double quotes ”” to search for an exact word or set of words.
include a word	Add a plus before the word to indicate that the word is mandatory
exclude a word	Add a dash – before the word to exclude all assets containing the word
wildcards	and ? wildcards represent arbitrary terms or characters, respectively
logical operators	AND, OR, NOT, note that logical operators have to be written in CAPITAL letters
parentheses	( and ) may be used to control the sequence of evaluation
( and ) may be used to control the sequence of evaluation	Use the asset attribute name followed by a colon and the desired asset attribute value to search in specific document fields only. In case of hierarchical asset attributes the dot notation is supported (e. g. contributions.contributorNames)

In general, ECDAPI searches for the query string in the document attributes which have been configured to support full text search. Those will be pre-configured according to the Simply.TV data model via the schema configuration file described in Document schema configuration.


The search feature of CDAPI supports all the generic functionality of Retrieve Documents by Filter (filtering, entitlements, annotations). The
differences are:

• search does not support the beforeAfter attribute
• in addition search supports the query (=search term) attribute
• in addition search supports search term highlighting in the results
• in addition search supports searchWeights
• Avoid or escape special characters in the search query