Sha256: b0e08edc9a63241e663eff7d98c803ab385a2bb100ac739f903aebf8a1932a1a

Contents?: true

Size: 1.21 KB

Versions: 44

Compression:

Stored size: 1.21 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] |
| **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

44 entries across 44 versions & 2 rubygems

Version Path
purecloudplatformclientv2-3.1.0 docs/SearchRequest.md
purecloudplatformclientv2-3.0.0 docs/SearchRequest.md
purecloudplatformclientv2-2.0.40 docs/SearchRequest.md
purecloudplatformclientv2-2.0.39 docs/SearchRequest.md
purecloudplatformclientv2-2.0.38 docs/SearchRequest.md
purecloudplatformclientv2-2.0.37 docs/SearchRequest.md
purecloudplatformclientv2-2.0.36 docs/SearchRequest.md
purecloudplatformclientv2-2.0.35 docs/SearchRequest.md
purecloudplatformclientv2-2.0.33 docs/SearchRequest.md
purecloudplatformclientv2-2.0.32 docs/SearchRequest.md
purecloudplatformclientv2-2.0.30 docs/SearchRequest.md
purecloudplatformclientv2-2.0.23 docs/SearchRequest.md
purecloudplatformclientv2-2.0.21 docs/SearchRequest.md
purecloudplatformclientv2-2.0.18 docs/SearchRequest.md
purecloudplatformclientv2-2.0.17 docs/SearchRequest.md
purecloudplatformclientv2-2.0.14 docs/SearchRequest.md
purecloudplatformclientv2-2.0.13 docs/SearchRequest.md
purecloudplatformclientv2-2.0.10 docs/SearchRequest.md
purecloudplatformclientv2-2.0.9 docs/SearchRequest.md
purecloudplatformclientv2-2.0.8 docs/SearchRequest.md