SearchResult Data Type

Type that describes the data resources or fields returned in a search. The search criteria are also included.

Abstract Type
Properties
name data type description
refDataResources array of object
facetSelections array of FacetSelection
preFilters array of FacetSelection
entities array of object
facetResults array of FacetResult
matchedEntityCount number
matchedKeys array of string
responseEntityCount number
facetGroups array of object

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "refDataResources" : [ { }, { } ],
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "preFilters" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "entities" : [ { }, { } ],
  "facetResults" : [ {
    "name" : "...",
    "totalCount" : 12345,
    "categoryCounts" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "displayName" : "..."
  }, {
    "name" : "...",
    "totalCount" : 12345,
    "categoryCounts" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "displayName" : "..."
  } ],
  "matchedEntityCount" : 12345,
  "matchedKeys" : [ "...", "..." ],
  "responseEntityCount" : 12345,
  "facetGroups" : [ { }, { } ]
}