Table of Contents
Overview
Introduction
The Search and Retrieve API provides a means for looking up content from an App based on search criteria, include related content and return only the relevant fields for a specific use case from an App. That App could be an iOS or Android mobile app or it could be a web app or another kind of web site requesting the content. It can be used to search for any content, but it is especially useful for Headless content, since it allows for referenced content to be included and for field filtering. It is very fast thanks to searching using the Apache Solr search engine and retrieving content via the powerful XperienCentral cache. The search queries are concise and written either in JSON, usually used when querying from code, or YAML which is easier to read and write when developing or testing queries.
Basic usage
Send an HTTP POST request to https://yoursite.com/web/searchretrieve/v1/yaml containing a search query like this:
| Code Block |
|---|
search:
text: The text to search for in your content |
It will return
Prerequisites: XperienCentral R32+ or R27+ with the Headless Add-on upgraded to version 2.2.5+. The checkbox search_retrieve_enabled needs to be checked in the Setup tool.
Misc - TODO
- For media items, the display-on page version in the media item language will always be used, also when the media item fallbacks to another language than the requested one.
...