Sha256: 4cf89ea47495906f7452e8bda9b8b51b10ba73ac0593225893a8b5d47916b0c9

Contents?: true

Size: 1.17 KB

Versions: 10

Compression:

Stored size: 1.17 KB

Contents

---
title: FacetRequest
---
## PureCloud::FacetRequest

## Properties

|Name | Type | Description | Notes|
|------------ | ------------- | ------------- | -------------|
| **name** | **String** | name of the facet request that will be returned with the result set | |
| **facet_request_query_type** | **String** | Which facet request type | |
| **field_name** | **String** | The fieldName to perform the facet request on. | |
| **type** | **String** | the fieldtype of the field to perform the facet request on. | [optional] |
| **range_from** | **String** | For RANGE requests populate this field to specify the beginning of a limit (leave blank for openended).  Note this value is inclusive of the results.  (EG if the value is 1, 1 will be included in the range.) | [optional] |
| **range_to** | **String** | For RANGE requests populate this field to specify the end of a limit (leave blank for openended).  Note this value is EXCLUSIVE of the result (EG if this value was 5, only values LESS THAN 5 will be included in the count.) | [optional] |
| **max_facet_count** | **Integer** | Limits/expands the number of facet entries returned (default 500) | [optional] |
{: class="table table-striped"}


Version data entries

10 entries across 10 versions & 1 rubygems

Version Path
purecloud-0.45.1 doc_out/FacetRequest.html.md
purecloud-0.44.1 doc_out/FacetRequest.html.md
purecloud-0.43.1 doc_out/FacetRequest.html.md
purecloud-0.42.1 doc_out/FacetRequest.html.md
purecloud-0.41.1 doc_out/FacetRequest.html.md
purecloud-0.40.1 doc_out/FacetRequest.html.md
purecloud-0.39.1 doc_out/FacetRequest.html.md
purecloud-0.38.1 doc_out/FacetRequest.html.md
purecloud-0.37.1 doc_out/FacetRequest.html.md
purecloud-0.36.1 doc_out/FacetRequest.html.md