Sha256: 64fba5cbf3446167680807028ddef242c088d0e87935f006975c048cf03619d9
Contents?: true
Size: 1.34 KB
Versions: 100
Compression:
Stored size: 1.34 KB
Contents
---
title: SearchRequest
---
## PureCloud::SearchRequest
## Properties
|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **sort_order** | **String** | The sort order for results | [optional] |
| **sort_by** | **String** | The field in the resource that you want to sort the results by | [optional] |
| **page_size** | **Integer** | The number of results per page | [optional] |
| **page_number** | **Integer** | The page of resources you want to retrieve | [optional] |
| **sort** | [**Array<SearchSort>**](SearchSort.html) | Multi-value sort order, list of multiple sort values | [optional] |
| **return_fields** | **Array<String>** | A List of strings. Possible values are any field in the resource you are searching on. The other option is to use ALL_FIELDS, when this is provided all fields in the resource will be returned in the search results. | [optional] |
| **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
| **types** | **Array<String>** | Resource domain type to search | |
| **query** | [**Array<SearchCriteria>**](SearchCriteria.html) | The search criteria | [optional] |
| **aggregations** | [**Array<SearchAggregation>**](SearchAggregation.html) | Aggregation criteria | [optional] |
{: class="table table-striped"}
Version data entries
100 entries across 100 versions & 1 rubygems