{"id":811,"date":"2017-08-16T20:21:16","date_gmt":"2017-08-16T20:21:16","guid":{"rendered":"http:\/\/live.ecd-demo.com\/apihelp\/?page_id=811"},"modified":"2025-07-21T17:19:43","modified_gmt":"2025-07-21T17:19:43","slug":"search","status":"publish","type":"page","link":"https:\/\/apihelp.ecd-demo.com\/index.php\/documentation\/what-does-the-api-contain\/search\/","title":{"rendered":"Search"},"content":{"rendered":"\n\n<h4 class=\"wp-block-heading\">SEARCH<\/h4>\n\n\n\n\nCDAPI&#8217;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:\n\n\n\n\n<div style=\"height:29px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n\n\n<h5 class=\"wp-block-heading\">Features<\/h5>\n\n\n\n\n<figure class=\"wp-block-table is-style-stripes\">\n\n<table><tbody><tr><td><strong>Search Functions<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td>search for an exact word or phrase<\/td><td>Use double quotes \u201d\u201d to search for an exact word or set of<br> words.<\/td><\/tr><tr><td>include a word<\/td><td>Add a plus before the word to indicate that the word is mandatory<\/td><\/tr><tr><td>exclude a word<\/td><td>Add a dash \u2013 before the word to exclude all assets containing the<br> word<\/td><\/tr><tr><td>wildcards<\/td><td> and ? wildcards represent arbitrary terms or characters,<br> respectively <\/td><\/tr><tr><td>logical operators<\/td><td>AND, OR, NOT, note that logical operators have to be written in<br> CAPITAL letters<\/td><\/tr><tr><td>parentheses<\/td><td>( and ) may be used to control the sequence of evaluation<\/td><\/tr><tr><td>( and ) may be used to control the sequence of evaluation<\/td><td>Use the asset attribute name followed by a colon and the desired<br> asset attribute value to search in specific document fields only. In<br> case of hierarchical asset attributes the dot notation is supported (e.<br> g. contributions.contributorNames)<\/td><\/tr><\/tbody><\/table>\n\n<\/figure>\n\n\n\nIn 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.<br><br><br>The search feature of CDAPI supports all the generic functionality of Retrieve Documents by Filter (filtering, entitlements, annotations). The<br>differences are:\n\n\n\n\n<ul class=\"wp-block-list\"><li>search does not support the <em>beforeAfter <\/em>attribute<\/li><li>in addition search supports the <strong>query <\/strong>(=search term) attribute<\/li><li>in addition search supports search term <em>highlighting <\/em>in the results<\/li><li>in addition search supports <strong>searchWeights<\/strong><\/li><li>Avoid or escape special characters in the search query<\/li><\/ul>\n\n\n\n\n\n","protected":false},"excerpt":{"rendered":"<p>SEARCH CDAPI&#8217;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 \u201d\u201d to search for an exact word [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":66,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-811","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/811","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/comments?post=811"}],"version-history":[{"count":1,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/811\/revisions"}],"predecessor-version":[{"id":1493,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/811\/revisions\/1493"}],"up":[{"embeddable":true,"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/pages\/66"}],"wp:attachment":[{"href":"https:\/\/apihelp.ecd-demo.com\/index.php\/wp-json\/wp\/v2\/media?parent=811"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}