alfresco 1.0.0

data/docs/RequestFacetFields.md

@@ -0,0 +1,8 @@
+# Alfresco::RequestFacetFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**facets** | [**Array<RequestFacetField>**](RequestFacetField.md) | Define specifc fields on which to facet (adds SOLR facet.field and f.<field>.facet.* options)  | [optional] 
+
+

data/docs/RequestFacetIntervals.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestFacetIntervals
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sets** | [**Array<RequestFacetSet>**](RequestFacetSet.md) | Sets the intervals for all fields. | [optional] 
+**intervals** | [**Array<RequestFacetIntervalsIntervals>**](RequestFacetIntervalsIntervals.md) | Specifies the fields to facet by interval. | [optional] 
+
+

data/docs/RequestFacetIntervalsIntervals.md

@@ -0,0 +1,10 @@
+# Alfresco::RequestFacetIntervalsIntervals
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The field to facet on | [optional] 
+**label** | **String** | A label to use to identify the field facet | [optional] 
+**sets** | [**Array<RequestFacetSet>**](RequestFacetSet.md) | Sets the intervals for all fields. | [optional] 
+
+

data/docs/RequestFacetQueries.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestFacetQueries
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestFacetQueriesInner.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestFacetQueriesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | A facet query | [optional] 
+**label** | **String** | A label to include in place of the facet query | [optional] 
+
+

data/docs/RequestFacetSet.md

@@ -0,0 +1,12 @@
+# Alfresco::RequestFacetSet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | A label to use to identify the set | [optional] 
+**start** | **String** | The start of the range | [optional] 
+**_end** | **String** | The end of the range | [optional] 
+**start_inclusive** | **BOOLEAN** | When true, the set will include values greater or equal to \"start\" | [optional] [default to true]
+**end_inclusive** | **BOOLEAN** | When true, the set will include values less than or equal to \"end\" | [optional] [default to true]
+
+

data/docs/RequestFields.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestFilterQueries.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestFilterQueries
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestFilterQueriesInner.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestFilterQueriesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | The filter query expression. For multi-select facets selected facets must be order together  | [optional] 
+**tags** | **Array<String>** | Tags used exclude the filters from facet evaluation for multi-select facet support | [optional] 
+
+

data/docs/RequestHighlight.md

@@ -0,0 +1,15 @@
+# Alfresco::RequestHighlight
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **String** | The string used to mark the start of a highlight in a fragment. | [optional] 
+**postfix** | **String** | The string used to mark the end of a highlight in a fragment. | [optional] 
+**snippet_count** | **Integer** | The maximum number of distinct highlight snippets to return for each highlight field. | [optional] 
+**fragment_size** | **Integer** | The character length of each snippet. | [optional] 
+**max_analyzed_chars** | **Integer** | The number of characters to be considered for highlighting. Matches after this count will not be shown. | [optional] 
+**merge_contiguous** | **BOOLEAN** | If fragments over lap they can be  merged into one larger fragment | [optional] 
+**use_phrase_highlighter** | **BOOLEAN** | Should phrases be identified. | [optional] 
+**fields** | [**Array<RequestHighlightFields>**](RequestHighlightFields.md) | The fields to highlight and field specific configuration properties for each field | [optional] 
+
+

data/docs/RequestHighlightFields.md

@@ -0,0 +1,13 @@
+# Alfresco::RequestHighlightFields
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The name of the field to highlight. | [optional] 
+**snippet_count** | **Integer** |  | [optional] 
+**fragment_size** | **Integer** |  | [optional] 
+**merge_contiguous** | **BOOLEAN** |  | [optional] 
+**prefix** | **String** |  | [optional] 
+**postfix** | **String** |  | [optional] 
+
+

data/docs/RequestInclude.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestInclude
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestLimits.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestLimits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**permission_evaluation_time** | **Integer** | Maximum time for post query permission evaluation | [optional] 
+**permission_evaluation_count** | **Integer** | Maximum count of post query permission evaluations | [optional] 
+
+

data/docs/RequestLocalization.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestLocalization
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timezone** | **String** | A valid timezone id supported by @see java.time.ZoneId | [optional] 
+**locales** | **Array<String>** | A list of Locales definied by IETF BCP 47.  The ordering is significant.  The first locale (leftmost) is used for sort and query localization, whereas the remaining locales are used for query only. | [optional] 
+
+

data/docs/RequestPagination.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestPagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**max_items** | **Integer** | The maximum number of items to return in the query results | [optional] 
+**skip_count** | **Integer** | The number of items to skip from the start of the query set | [optional] 
+
+

data/docs/RequestPivot.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestPivot
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** | A key corresponding to a matching field facet label or stats. | [optional] 
+**pivots** | [**Array<RequestPivot>**](RequestPivot.md) |  | [optional] 
+
+

data/docs/RequestQuery.md

@@ -0,0 +1,10 @@
+# Alfresco::RequestQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | The query language in which the query is written. | [optional] [default to "afts"]
+**user_query** | **String** | The exact search request typed in by the user | [optional] 
+**query** | **String** | The query which may have been generated in some way from the userQuery | 
+
+

data/docs/RequestRange.md

@@ -0,0 +1,16 @@
+# Alfresco::RequestRange
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The name of the field to perform range | [optional] 
+**start** | **String** | The start of the range | [optional] 
+**_end** | **String** | The end of the range | [optional] 
+**gap** | **String** | Bucket size | [optional] 
+**hardend** | **BOOLEAN** | If true means that the last bucket will end at “end” even if it is less than “gap” wide. | [optional] 
+**other** | **Array<String>** | before, after, between, non, all | [optional] 
+**include** | **Array<String>** | lower, upper, edge, outer, all | [optional] 
+**label** | **String** | A label to include as a pivot reference | [optional] 
+**exclude_filters** | **Array<String>** | Filter queries to exclude when calculating statistics | [optional] 
+
+

data/docs/RequestScope.md

@@ -0,0 +1,8 @@
+# Alfresco::RequestScope
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**locations** | **String** | The locations to include in the query  | [optional] 
+
+

data/docs/RequestSortDefinition.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestSortDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestSortDefinitionInner.md

@@ -0,0 +1,10 @@
+# Alfresco::RequestSortDefinitionInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | How to order - using a field, when position of the document in the index, score/relevence. | [optional] [default to "FIELD"]
+**field** | **String** | The name of the field | [optional] 
+**ascending** | **BOOLEAN** | The sort order. (The ordering of nulls is determined by the SOLR configuration) | [optional] [default to false]
+
+

data/docs/RequestSpellcheck.md

@@ -0,0 +1,8 @@
+# Alfresco::RequestSpellcheck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** |  | [optional] 
+
+

data/docs/RequestStats.md

@@ -0,0 +1,23 @@
+# Alfresco::RequestStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**field** | **String** | The stats field | [optional] 
+**label** | **String** | A label to include for reference the stats field | [optional] 
+**min** | **BOOLEAN** | The minimum value of the field | [optional] [default to true]
+**max** | **BOOLEAN** | The maximum value of the field | [optional] [default to true]
+**sum** | **BOOLEAN** | The sum of all values of the field | [optional] [default to true]
+**count_values** | **BOOLEAN** | The number which have a value for this field | [optional] [default to true]
+**missing** | **BOOLEAN** | The number which do not have a value for this field | [optional] [default to true]
+**mean** | **BOOLEAN** | The average | [optional] [default to true]
+**stddev** | **BOOLEAN** | Standard deviation | [optional] [default to true]
+**sum_of_squares** | **BOOLEAN** | Sum of all values squared | [optional] [default to true]
+**distinct_values** | **BOOLEAN** | The set of all distinct values for the field (This can be very expensive to calculate) | [optional] [default to false]
+**count_distinct** | **BOOLEAN** | The number of distinct values  (This can be very expensive to calculate) | [optional] [default to false]
+**cardinality** | **BOOLEAN** | A statistical approximation of the number of distinct values | [optional] [default to false]
+**cardinality_accuracy** | **Float** | Number between 0.0 and 1.0 indicating how aggressively the algorithm should try to be accurate. Used with boolean cardinality flag. | [optional] [default to 0.3]
+**exclude_filters** | **Array<String>** | A list of filters to exclude | [optional] 
+**percentiles** | **Array<Float>** | A list of percentile values, e.g. \"1,99,99.9\" | [optional] 
+
+

data/docs/RequestTemplates.md

@@ -0,0 +1,7 @@
+# Alfresco::RequestTemplates
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/RequestTemplatesInner.md

@@ -0,0 +1,9 @@
+# Alfresco::RequestTemplatesInner
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The template name | [optional] 
+**template** | **String** | The template | [optional] 
+
+

data/docs/ResponseConsistency.md

@@ -0,0 +1,8 @@
+# Alfresco::ResponseConsistency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**last_tx_id** | **Integer** | The id of the last indexed transaction | [optional] 
+
+

data/docs/ResultBuckets.md

@@ -0,0 +1,9 @@
+# Alfresco::ResultBuckets
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | The field name or its explicit label, if provided on the request | [optional] 
+**buckets** | [**Array<ResultBucketsBuckets>**](ResultBucketsBuckets.md) | An array of buckets and values | [optional] 
+
+

data/docs/ResultBucketsBuckets.md

@@ -0,0 +1,11 @@
+# Alfresco::ResultBucketsBuckets
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** | The bucket label | [optional] 
+**filter_query** | **String** | The filter query you can use to apply this facet | [optional] 
+**count** | **Integer** | The count for the bucket | [optional] 
+**display** | **Object** | An optional field for additional display information | [optional] 
+
+

data/docs/ResultNode.md

@@ -0,0 +1,29 @@
+# Alfresco::ResultNode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** | The name must not contain spaces or the following special characters: * \" < > \\ / ? : and |. The character . must not be used at the end of the name.  | 
+**node_type** | **String** |  | 
+**is_folder** | **BOOLEAN** |  | 
+**is_file** | **BOOLEAN** |  | 
+**is_locked** | **BOOLEAN** |  | [optional] [default to false]
+**modified_at** | **DateTime** |  | 
+**modified_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**created_at** | **DateTime** |  | 
+**created_by_user** | [**UserInfo**](UserInfo.md) |  | 
+**parent_id** | **String** |  | [optional] 
+**is_link** | **BOOLEAN** |  | [optional] 
+**content** | [**ContentInfo**](ContentInfo.md) |  | [optional] 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Object** |  | [optional] 
+**allowable_operations** | **Array<String>** |  | [optional] 
+**path** | [**PathInfo**](PathInfo.md) |  | [optional] 
+**search** | [**SearchEntry**](SearchEntry.md) |  | [optional] 
+**archived_by_user** | [**UserInfo**](UserInfo.md) |  | [optional] 
+**archived_at** | **DateTime** |  | [optional] 
+**version_label** | **String** |  | [optional] 
+**version_comment** | **String** |  | [optional] 
+
+

data/docs/ResultSetContext.md

@@ -0,0 +1,13 @@
+# Alfresco::ResultSetContext
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**consistency** | [**ResponseConsistency**](ResponseConsistency.md) |  | [optional] 
+**request** | [**SearchRequest**](SearchRequest.md) |  | [optional] 
+**facet_queries** | [**Array<ResultSetContextFacetQueries>**](ResultSetContextFacetQueries.md) | The counts from facet queries | [optional] 
+**facets_fields** | [**Array<ResultBuckets>**](ResultBuckets.md) | The counts from field facets | [optional] 
+**facets** | [**Array<GenericFacetResponse>**](GenericFacetResponse.md) | The faceted response | [optional] 
+**spellcheck** | [**Array<ResultSetContextSpellcheck>**](ResultSetContextSpellcheck.md) | Suggested corrections If zero results were found for the original query then a single entry of type \"searchInsteadFor\" will be returned. If alternatives were found that return more results than the original query they are returned as \"didYouMean\" options. The highest quality suggestion is first.  | [optional] 
+
+

data/docs/ResultSetContextFacetQueries.md

@@ -0,0 +1,10 @@
+# Alfresco::ResultSetContextFacetQueries
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**label** | **String** |  | [optional] 
+**filter_query** | **String** | The filter query you can use to apply this facet | [optional] 
+**count** | **Integer** |  | [optional] 
+
+

data/docs/ResultSetContextSpellcheck.md

@@ -0,0 +1,9 @@
+# Alfresco::ResultSetContextSpellcheck
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**suggestion** | **Array<String>** | A suggested alternative query | [optional] 
+
+

data/docs/ResultSetPaging.md

@@ -0,0 +1,8 @@
+# Alfresco::ResultSetPaging
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**list** | [**ResultSetPagingList**](ResultSetPagingList.md) |  | [optional] 
+
+

data/docs/ResultSetPagingList.md

@@ -0,0 +1,10 @@
+# Alfresco::ResultSetPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**context** | [**ResultSetContext**](ResultSetContext.md) |  | [optional] 
+**entries** | [**Array<ResultSetRowEntry>**](ResultSetRowEntry.md) |  | [optional] 
+
+

data/docs/ResultSetRowEntry.md

@@ -0,0 +1,8 @@
+# Alfresco::ResultSetRowEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**ResultNode**](ResultNode.md) |  | 
+
+

data/docs/SearchApi.md

@@ -0,0 +1,62 @@
+# Alfresco::SearchApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/search/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](SearchApi.md#search) | **POST** /search | Searches Alfresco
+
+
+# **search**
+> ResultSetPaging search(query_body)
+
+Searches Alfresco
+
+**Note**: this endpoint is available in Alfresco 5.2 and newer versions. **You specify all the parameters in this API in a JSON body**, URL parameters are not supported. A basic query looks like this: ```JSON {   \"query\": {     \"query\": \"foo\"   } } ``` **Note:** These are the minimum possible query parameters. The default search language is **afts** ([Alfresco Full Text Search](http://docs.alfresco.com/5.1/concepts/rm-searchsyntax-intro.html)), but you can also specify **cmis**, and **lucene**. A basic CMIS query looks like this: ```JSON {   \"query\": {     \"query\": \"select * from cmis:folder\",     \"language\": \"cmis\"   } } ``` By default, **results are limited to the first 100.** Results can be restricted using \"paging\". For example: ```JSON \"paging\": {   \"maxItems\": \"50\",   \"skipCount\": \"28\" } ``` This example would ensure that results are **limited by Final Size**, skipping the first 28 results and returning the next 50. Alternatively, you can limit the results by using the **limits JSON body parameter**. For example, ```JSON \"limits\": {   \"permissionEvaluationTime\": 20000,   \"permissionEvaluationCount\": 2000 } ``` You can use the **include JSON body parameter** to return additional information. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"include\": [\"aspectNames\", \"properties\", \"isLink\"] ``` You can use the **fields JSON body parameter** to restrict the fields returned within a response if, for example, you want to save on overall bandwidth. This works in the same way as in the /nodes/{nodeId}/children method in the core API. For example: ```JSON \"fields\": [\"id\", \"name\", \"search\"] ``` You can sort the results using the **sort JSON body parameter**, for example: ```JSON \"sort\": [{\"type\":\"FIELD\", \"field\":\"cm:description\", \"ascending\":\"true\"}] ``` **Note:** the **sort** parameter is not supported for CMIS queries. By default, search uses the **\"nodes\" location**, which is the **content store known as workspace://SpacesStore**. To change the scope to another location you can use the **locations JSON body parameter**. You can specify either **nodes** (the default), **versions** or **deleted-nodes**.  For example, ```JSON \"scope\": {     \"locations\": [\"deleted-nodes\"] } ``` You can specify templates using the **templates JSON body parameter**, for example: ```JSON \"templates\": [{\"name\": \"_PERSON\",\"template\": \"|%firstName OR |%lastName OR |%userName\"},               {\"name\": \"mytemplate\",\"template\": \"%cm:content\"}] ``` **Note: Spell checking only works on Search Services (Solr 6) if you have already enabled suggestions.** For **spell checking** you can use a query like this: ```JSON {   \"query\": {     \"query\": \"cm:title:alfrezco\"   },   \"spellcheck\": {\"query\": \"alfrezco\"} } ``` If you are already specifying \"userQuery\" then the following may be easier and produces the same result : ```JSON {   \"query\": {     \"query\": \"cm:title:alfrezco\",     \"userQuery\": \"alfrezco\"   },   \"spellcheck\": {} } ``` The spellcheck response includes a spellCheck context like this: ```JSON \"context\": {   \"spellCheck\": {     \"type\": \"searchInsteadFor\",     \"suggestions\": [\"alfresco\"]   } }, ``` To specify defaults, you  use a **defaults JSON body parameter**, for example: ```JSON \"defaults\": {   \"textAttributes\": [     \"cm:content\", \"cm:name\"   ],   \"defaultFTSOperator\": \"AND\",   \"defaultFTSFieldOperator\": \"OR\",   \"namespace\": \"cm\",   \"defaultFieldName\": \"PATH\" } ``` You can specify several filter queries using the **filterQueries JSON body parameter**, for example: ```JSON \"filterQueries\": [{\"query\": \"TYPE:'cm:folder'\"},{\"query\": \"cm:creator:mjackson\"}] ``` You can specify several facet queries using the **facetQueries JSON body parameter**, for example: ```JSON \"facetQueries\": [{\"query\": \"created:2016\",\"label\": \"CreatedThisYear\"}] ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": {   \"facetQueries\": [     {\"label\": \"CreatedThisYear\",\"count\": 3}   ] }, ``` A complete query for facetting via the content.size field looks this: ```JSON {   \"query\": {     \"query\": \"presentation\",     \"language\": \"afts\"   },     \"facetQueries\": [         {\"query\": \"content.size:[0 TO 10240]\", \"label\": \"xtra small\"},         {\"query\": \"content.size:[10240 TO 102400]\", \"label\": \"small\"},         {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\"},         {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\"},         {\"query\": \"content.size:[16777216 TO 134217728]\", \"label\": \"xtra large\"},         {\"query\": \"content.size:[134217728 TO MAX]\", \"label\": \"XX large\"}   ],     \"facetFields\": {\"facets\": [{\"field\": \"'content.size'\"}]} } ``` The response will contain a matching \"context\" section, the \"label\" will match the facet query. ```JSON \"context\": {   \"facetQueries\": [     { \"label\": \"small\",\"count\": 2 },     { \"label\": \"large\",\"count\": 0 },     { \"label\": \"xtra small\",\"count\": 5 },     { \"label\": \"xtra large\",\"count\": 56},     { \"label\": \"medium\",\"count\": 4 },     { \"label\": \"XX large\", \"count\": 1 }   ] }, ``` You can specify several facet fields using the **facetFields JSON body parameter**, for example: ```JSON \"facetFields\": {\"facets\": [{\"field\": \"creator\", \"mincount\": 1}, {\"field\": \"modifier\", \"mincount\": 1}]} ``` The response will contain a matching \"context\" section, the \"label\" will match the facet field. ```JSON \"context\": {    \"facetsFields\": [      {  \"label\": \"creator\",         \"buckets\": [           { \"label\": \"System\", \"count\": 75 },           { \"label\": \"mjackson\", \"count\": 5 }         ]},      {  \"label\": \"modifier\",         \"buckets\": [           { \"label\": \"System\", \"count\": 72 },           { \"label\": \"mjackson\", \"count\": 5 },           { \"label\": \"admin\", \"count\": 3 }         ]}    ] }, ``` Grouping facet queries that go together can be done by specifying the group label in the fact queries as follow: ```JSON     {         \"query\": {             \"query\": \"presentation\"         },         \"facetQueries\": [             {\"query\": \"content.size:[0 TO 102400]\", \"label\": \"small\", \"group\":\"foo\"},             {\"query\": \"content.size:[102400 TO 1048576]\", \"label\": \"medium\",\"group\":\"foo\"},             {\"query\": \"content.size:[1048576 TO 16777216]\", \"label\": \"large\",\"group\":\"foo\"}         ]     } ``` The above query returns the results a faceted field grouped under the label foo: ```JSON {     \"context\": {\"facetsFields\": [{         \"label\": \"foo\",         \"buckets\": [             {                 \"count\": 109,                 \"label\": \"small\",                 \"filterQuery\": \"content.size:[0 TO 102400]\"             },             {                 \"count\": 0,                 \"label\": \"large\",                 \"filterQuery\": \"content.size:[1048576 TO 16777216]\"             },             {                 \"count\": 0,                 \"label\": \"medium\",                 \"filterQuery\": \"content.size:[102400 TO 1048576]\"             }         ]     }] } ``` Range Faceting is supported by the **ranges JSON body parameter**, for example: ```JSON     {         \"query\": {             \"query\": \"presentation\"         },         \"ranges\": [         {             \"field\": \"content.size\",              \"start\": \"0\",              \"end\": \"100\",              \"gap\": \"20\",              \"hardend\": true         },         {             \"field\": \"created\",             \"start\": \"2015-09-29T10:45:15.729Z\",             \"end\": \"2016-09-29T10:45:15.729Z\",             \"gap\": \"+100DAY\"         }]     } ``` An example query for **search highlighting** could look like this: ```JSON {   \"query\": {     \"query\": \"description:workflow\",     \"userQuery\":\"workflow\"   },   \"highlight\": {     \"prefix\": \"¿\",     \"postfix\": \"?\",     \"mergeContiguous\": true,     \"fields\": [       {         \"field\": \"cm:title\"       },       {         \"field\": \"description\",         \"prefix\": \"(\",         \"postfix\": \")\"       }     ]   } } ``` The example above changes the highlighting prefix and postfix from the  default <em> for all fields to ¿? and just for the \"description\" field to ().  The hightlight information is added in each node entry response; here is  an example partial response: ``` \"entry\": {         \"createdAt\": \"2016-10-12T15:24:31.202+0000\",         \"isFolder\": true,         \"search\": {           \"score\": 1,           \"highlight\": [             {               \"field\": \"cm:title\",               \"snippets\": [                 \"Customized ¿Workflow? Process Definitions\"               ]             },             {               \"field\": \"description\",               \"snippets\": [                 \"Customized (Workflow) Process Definitions\"               ]             }           ]       }, ``` 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco'
+# setup authorization
+Alfresco.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Alfresco::SearchApi.new
+
+query_body = Alfresco::SearchRequest.new # SearchRequest | Generic query API 
+
+
+begin
+  #Searches Alfresco
+  result = api_instance.search(query_body)
+  p result
+rescue Alfresco::ApiError => e
+  puts "Exception when calling SearchApi->search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query_body** | [**SearchRequest**](SearchRequest.md)| Generic query API  | 
+
+### Return type
+
+[**ResultSetPaging**](ResultSetPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+