SortingRuleSearchResult document (Data API 20.9)

Document representing a source code group search result.

Property Type Constraints Description
count Integer   The number of returned documents.
db_start_record_ Integer minIntegerValue=0 The zero-based index of the record that we want to start with, used to optimize special handling
expand [String]   List of expansions to be applied to each search results. Expands are optional
hits [SortingRule]   The sorted array of search hits. Can be empty.
next String   The URL of the next result page.
previous String   The URL of the previous result page.
query Query {BoolQuery, FilteredQuery, MatchAllQuery, NestedQuery, TermQuery, TextQuery}   The query passed into the search
select String   The fields that you want to select.
sorts [Sort]   The list of sort clauses configured for the search request. Sort clauses are optional.
start Integer minIntegerValue=0 The zero-based index of the first search hit to include in the result.
total Integer   The total number of documents.
OCAPI obsolete versions 13.x and 14.x will be end of life in 2020 and versions 15.x and 16.x in 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.
X Privacy Update: We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used. By continuing to use this site you are giving us your consent to do this. Privacy Policy.