SearchCriteria Data Type

Abstract Type
Properties
name data type constraints description
searchType SearchType  
pagingCriteria PagingCriteria  
lastSelectedFacetName string  
searchPhrase string  
facetSelections array of FacetSelection  
entityScope array of string  
sortBySpecs array of OrderbySpec  
applyFacets boolean required
partialSearch boolean required
preformedQuery boolean required

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "searchType" : "ADVANCED",
  "pagingCriteria" : {
    "start" : 12345,
    "size" : 12345
  },
  "lastSelectedFacetName" : "...",
  "searchPhrase" : "...",
  "facetSelections" : [ {
    "facetName" : "...",
    "displayName" : "...",
    "facetCategories" : [ "...", "..." ]
  }, {
    "facetName" : "...",
    "displayName" : "...",
    "facetCategories" : [ "...", "..." ]
  } ],
  "entityScope" : [ "...", "..." ],
  "sortBySpecs" : [ {
    "propertyName" : "...",
    "ascending" : true
  }, {
    "propertyName" : "...",
    "ascending" : true
  } ],
  "applyFacets" : true,
  "partialSearch" : true,
  "preformedQuery" : true
}