RoleSearchResult document (Data API 19.1)

Document representing an access role 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 [Role]   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.

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.

X OCAPI versions 15.x and 16.x will be retired on March 31, 2021. For dates and more information, see the OCAPI versioning and deprecation policy and this Knowledge Article.