...
| Table of Contents | ||||
|---|---|---|---|---|
|
Basic
...
Usage
To send an HTTP POST request to https://yoursite.com/web/searchretrieve/v1/yaml, the search query would be:
...
The examples here are written in YAML, but JSON is also supported. In general, YAML is clearer easier to read and write and can be written quickly which makes it useful when for doing search queries by hand. JSON is the more logical choice when serializing an object for the search query in your code or if you are more comfortable using it.
...
IDs and ID-based Lookup
There are various different kinds of IDs used in XperienCentral for different purposes. Content Item IDs are used to request specific content items via this API, often in combination with a specific language. That will return the current (=the current active ) version in that language. Version Version IDs are never used in the API. A Content Item can be A content item is either a Page page or a Media Itemmedia item. Since the numerical ID used for pages and media items might overlap, this internal ID is prefixed by either a "P" (for Page page) or an "M" for Media Item in (for media items) in this API. If the ID of a content item is already known from a previous search request, it can easily be retrieved using the ids the ID's parameter as shown in the example above.
Languages and "Display-on"
...
Pages
The Query results can be limited to either one or a number of explicit languages using the languages parameterthe languages parameter. See the Search Parameters below for details on the format. A Media Item media item is rendered via its "display-on" page. The language of the Media Item decides media item determines the language version of the display-on page. Therefore , therefore ensure that a display-on pages are available in all different languagespage is available for each supported language.
...
Responses
Successful responses
...