You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »


TODO: Add documentation here


Misc

  • 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. 

Search parameters

Ralph Voorips: TODO

Parameter nameDescriptionExample (yaml)Example (json)
idsSearch for a content item using the item's content id (Note: NOT the content item version id). When you are looking for a Page the ID needs to be prefixed with a P, when looking for a media item the ID should be prefixed with an M. So for example for a page it would be P26111 and for a media item it would be M1. This parameter can be used to together with the languages parameter in order to retrieve the correct version. When the languages parameter is not specified the channel's default language will be used to determine the version of the article to return.
search: 
  ids:
  - P26111
  - M1
{
"search": {
  "ids": [
    "P26111",
    "M1"
 ]}
}
textThis field can be used to search for any text in the title or the body of the documents in the content index
search:
  text: lorem
{
"search": {
  "text": "lorem"
  }
}
keywordsAndAdd a list of keywords to the query. The results have to contain all the listed keywords.
search:  
  keywordsAnd:
  - term 1
  - term 2
{
"search": {
  "keywordsAnd": [
    "term 1",
    "term 2"
  ]}
}
keywordsAndAdd a list of keywords to the query. The results have to contain one or more of the keywords specified
search:
  keywordsOr:
  - term 1
  - term 2
{
"search": {
  "keywordsOr": [
    "term 1",
    "term 2" 
  ]}
}
keywordsNotAdd a list of keywords to the query. The results may not contain any of the listed keywords.
search:
  keywordsNot:
  - term 1
  - term 2
{
"search": {
  "keywordsNot": [
    "term 1",
    "term 2"  
  ]}
}
































  • No labels