SearchCriteria Data Type

Type that describes the criteria for searching on data resources or fields. Criteria can include a keyword and/or facets.

Abstract Type
Properties
name data type description
pagingCriteria PagingCriteria
searchPhrase string
facetSelections array of FacetSelection
entityScope array of string
searchType SearchType
partialSearch boolean

Example

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