Page Comparison

ids

Search for a content item using the item's content ID. Note that this is not the content item version ID. When searching for a page, the ID must be prefixed with a "P" and when searching for a media item, the ID should be prefixed with an "M". For example, searching for a page would with the content ID 26111, you would use P26111 and searching for a media with the content ID of 1, you would use M1.

This parameter can be used together with the languages parameter in order to retrieve the current or active version for those languages. When no languages are specified, the current version for all languages defined in XperienCentral are returned.

search: 
  ids:
  - P26111
  - M1

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

languages

search: 
  languages:
  - en_US
  - nl

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

text

search:
  text: lorem

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

keywords 

(simple configuration)

search:  
  keywords: term 1

{
"search": {
  "keywords": "term 1"
  }
}

keywords

(advanced configuration)

search:  
  keywords:
    and:
    - term 1
    - term 2
    not:
    - term 3

{
  "search": {
    "keywords": {
      "and": [
        "term 1",
        "term 2"
       ],
       "not": [
         "term 3"
       ]
    }
  }
}

types

Allows filtering on specific content types. The following parameters are allowed:

• page
• download
• article
• image
• media page
• multimedia
• any custom content item identifier, for example helloworldmediaitem
• any modular content type identifier, prefixed with wmammodularcontent_, for example wmammodularcontent_news
• mediaitem - This type is a special case. If this parameter is provided, all types of media items will be returned. This parameter can not be used in combination with the other types. If other types are provided together with mediaitem, an exception will be thrown.

search:
  types:
  - page
  - article
  - download
  - helloworldmediaitem

{
  "search": {
    "types": [
      "page",
      "article",
      "download",
      "helloworldmediaitem"
    ]
  }
}

keywordCategories

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

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

sortBy

Specifies which field should be used to sort the results. The following options are supported:

• lastModifiedDate
• publicationDate
• score (default)

search:
  sortBy: publicationDate

{
  "search": {
    "sortBy": "publicationDate"
  }
}

sortOrder

search:
  sortOrder: asc

{
  "search": {
     "sortOrder": "asc"
  }
}

publicationDate

Supports filtering the results by publication date. A from and/or a to parameter can be provided. If only a from parameter is provided, the results will contain documents that are published between the specified date and now. If only a to parameter is specified, all results with a publication date up to the provided date will be retrieved. Please note that dates should be provided in a ISO-8601 format.

When using Javascript it's really easy to retrieve an ISO string for a Date object. The Date object has a function toISOString() that will return a proper ISO String, using UTC as the timezone. The provided time on the creation of the Date object is converted accordingly.

search:
  publicationDate:
    from: 2021-03-19T14:58+02:00
    to: 2021-05-19T14:58Z

{
  "search": {
    "publicationDate": {
      "from": "2021-03-19T14:58+02:00",
      "to": "2021-05-19T14:58Z"
    }
  }
}

<custom fields>

(simple configuration)

Custom fields can be used to query fields that are not explicitly exposed via the Search and Retrieve API. Examples of these are fields that are added to the content index via annotating methods in custom media items or fields in a Modular Content template that are configured to be indexed. The custom field option supports the same query parameter types as the keyword parameter (both a simple and an advanced query type). To query a custom field, use the identifier of the field as it's stored in the Content Index and provide the value to search for. See the column to the right for examples.

Modular Content fields

Fields in a Modular Content Template can be configured to be indexed in the content index automatically. The identifiers that should be used to query for these fields depend on the exact configuration of that field. In all cases, the identifier should be prefixed with mcf_. If the Search Index value in the configuration of the field is set to one of the "Unique ..." values, the identifier should also include the identifier of the Modular Template as follows:

modular_<identifier-of-the-template>0<identifier-of-the-field>

When the Search Index value is set to "Combined ...", the template identifier can be omitted as follows:

modular_<identifier-of-the-field>

Discovering and Debugging Fields in the Content Index

The /wiki/spaces/GX/pages/25436300 allows the user to discover which fields are available within the content index. When this plugin is installed, your role requires the "Developer options" permission for the Solr Maintenance panel in the Authorization panel. Open the Solr Maintenance panel and navigate to Developer Options > Explore the content index to explore the content index. Set the radio button  "Show all facet info" to "yes" to show a list of all available facets per result.

Combining Multiple Custom Fields

It's possible to query for multiple custom fields at the same time by combining both simple and advanced query parameters, as well as "regular" and Modular Content Fields.

search:
  pageversion_navigationtitle: Navigatie titel

search:
  modular_string4: value 1
  modular_news0string:
    and:
    - value 1
    - value 2

{
  "search": {
    "pageversion_navigationtitle": "Navigatie titel"
  }
}

{
  "search": {
    "modular_string4": "value 1",
    "modular_news0string": {
      "and": [
        "value 1",   
        "value 2"
      ]
    }
  }
}

<custom fields>

(advanced configuration)

search:
  pageversion_navigationtitle: Navigatie titel
  modular_string4:
    and:
    - value 1
    - value 2
  modular_news0string:
    not:
    - value 3

{
  "search": {
    "pageversion_navigationtitle": "Navigatie titel",
    "modular_string4": {
      "and": [
        "value 1",
        "value 2"
      ]
    },
    "modular_news0string": {
       "not": [
          "value 3"
       ]
    }
  }
}

from

search:
  from: 3

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

to

search:
  to: 3

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