...

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

This open query will return JSON containing the contents of all content items matching the text in all languages matching the text. For example:

{
  "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 ...
  } ]
}

...

To retrieve results 11 to 20 of content items in English with the keywords , tags, labels and terms) "news" and "sports", the query would be:

...

To retrieve the Dutch content item versions for the content items with ID M1 and P26111, the query would be":

search:
  ids: 
  - M1
  - P26111
  languages:
  - nl

...

• Rate limitations to protect the server from Denial of Service attacks ("DDoS") and other security enhancements
• The inclusion of referenced items in the response
• Field filtering to only retrieve relevant fields in the response
• Support for more types of search criteria including custom fields

If you have access to our the GX Software Jira issue tracking system, see thttps://connect.gxsoftware.com/jira/browse/XA-636 and its sub-tasks for all the technical details. The XperienCentral Headless add-on, which contains this functionality, can be upgraded without upgrading XperienCentral.

...

Both HTTPS and HTTP are accepted as well as other context paths. To construct a search query in JSON format, use a URL that ends in /json. For example:

https://yoursite.com/web/searchretrieve/v1/json

...

The examples here are written in YAML, but JSON is also supported. In general, YAML is easier to read and write and can be written quickly which makes it useful 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.

This The following YAML

search:
  ids: 
  - M123
  - P12345
  languages:
  - nl

...

There are various different 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 that will return the current active version in that language. Version IDs are never used in the API. A content item is either a page or a media item. Since the numerical ID used for pages and media items might overlap, this internal ID is prefixed by either a "P" (for a page) or an "M" (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 ID's parameter as shown in the example above.

...

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 is rendered via its "display-on" page. The language of the media item determines the language version of the display-on page, therefore you must ensure that a display-on page is available for each supported language.

...

A search might fail due to a malformed search query. In that case, the response will contain an error message. Since an internal parse error is passed on, it might looks similar to the following:

...

Anchor
search-parameters search-parameters

Search Parameters

The list below following are the currently supported parameters for querying the Search & Retrieve API. This list will be expanded in future releases.

...

search: 
  ids:
  - P26111
  - M1

{
"search": {
  "ids": [
    "P26111",
    "M1"
 ]}
}

search: 
  languages:
  - en_US
  - nl

{
"search": {
  "languages": [
    "en_US",
    "nl"
  ]}
}

search:
  text: lorem

{
"search": {
  "text": "lorem"
  }
}

search:  
  keywordsAnd:
  - term 1
  - term 2

{
"search": {
  "keywordsAnd": [
    "term 1",
    "term 2"
  ]}
}

search:  
  keywordsOr:
  - term 1
  - term 2

{
"search": {
  "keywordsOr": [
    "term 1",
    "term 2"
  ]}
}

search:
  keywordsNot:
  - term 1
  - term 2

{
"search": {
  "keywordsNot": [
    "term 1",
    "term 2"  
  ]}
}

search:
  keywordCategories:
  - term category 1
  - term category 2

{
"search": {
  "keywordCategories": [
    "term category 1",
    "term category 2"
  ]}
}

search:
  from: 3

{
"search": {
  "from": 3
  }
}

search:
  to: 3

{
"search": {
  "to": 5
  }
}

...