Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel2
minLevel2

Basic usage

Send To send an HTTP POST request to to https://yoursite.com/web/searchretrieve/v1/yaml containing a , the search query like thiswould be:


Code Block
search:
  text: The text to search for in your content


This very open query will return a JSON containing the contents of all content items (with a limit) matching the text in all languages, in this form. For example:


Code Block
{
  "results" : [ {
    "_searchRetrieve" : {
      "contentItemID" : "M123",
      "language" : "nl_NL",
      "success" : true
    },
    ... JSON contents of the first result ...
  }, {
    "_searchRetrieve" : {
      "contentItemID" : "P12345",
      "language" : "en_US",
      "success" : true
    },
    ... JSON contents of the first result ...
  } ]
}


Prerequisites for testing this yourself: XperienCentral R32+ or R27+ with the In order to use this functionality, you need XperienCentral versions R32 and higher or versions R27 and higher if you have the  Headless Add-on upgraded to version 2.2.5 +or higher. The checkbox setting search_retrieve_enabled needs to be checked in the Setup tool.Tooling: in the headless_search_retrieve section on the General tab of the Setup Tool must be enabled. A free tool for sending such requests is Postman.

...