alfresco_api 1.0.0

data/docs/PermissionElement.md

@@ -0,0 +1,10 @@
+# AlfrescoAPI::PermissionElement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**authority_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**access_status** | **String** |  | [optional] [default to "ALLOWED"]
+
+

data/docs/PermissionsBodyUpdate.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::PermissionsBodyUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_inheritance_enabled** | **BOOLEAN** |  | [optional] 
+**locally_set** | [**Array<PermissionElement>**](PermissionElement.md) |  | [optional] 
+
+

data/docs/PermissionsInfo.md

@@ -0,0 +1,11 @@
+# AlfrescoAPI::PermissionsInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_inheritance_enabled** | **BOOLEAN** |  | [optional] 
+**inherited** | [**Array<PermissionElement>**](PermissionElement.md) |  | [optional] 
+**locally_set** | [**Array<PermissionElement>**](PermissionElement.md) |  | [optional] 
+**settable** | **Array<String>** |  | [optional] 
+
+

data/docs/Person.md

@@ -0,0 +1,27 @@
+# AlfrescoAPI::Person
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**first_name** | **String** |  | 
+**last_name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**avatar_id** | **String** |  | [optional] 
+**email** | **String** |  | 
+**skype_id** | **String** |  | [optional] 
+**google_id** | **String** |  | [optional] 
+**instant_message_id** | **String** |  | [optional] 
+**job_title** | **String** |  | [optional] 
+**location** | **String** |  | [optional] 
+**company** | [**Company**](Company.md) |  | [optional] 
+**mobile** | **String** |  | [optional] 
+**telephone** | **String** |  | [optional] 
+**status_updated_at** | **DateTime** |  | [optional] 
+**user_status** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [default to true]
+**email_notifications_enabled** | **BOOLEAN** |  | [optional] [default to true]
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/PersonBodyCreate.md

@@ -0,0 +1,26 @@
+# AlfrescoAPI::PersonBodyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**first_name** | **String** |  | 
+**last_name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**email** | **String** |  | 
+**skype_id** | **String** |  | [optional] 
+**google_id** | **String** |  | [optional] 
+**instant_message_id** | **String** |  | [optional] 
+**job_title** | **String** |  | [optional] 
+**location** | **String** |  | [optional] 
+**company** | [**Company**](Company.md) |  | [optional] 
+**mobile** | **String** |  | [optional] 
+**telephone** | **String** |  | [optional] 
+**user_status** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] [default to true]
+**email_notifications_enabled** | **BOOLEAN** |  | [optional] [default to true]
+**password** | **String** |  | 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/PersonBodyUpdate.md

@@ -0,0 +1,26 @@
+# AlfrescoAPI::PersonBodyUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | [optional] 
+**last_name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**skype_id** | **String** |  | [optional] 
+**google_id** | **String** |  | [optional] 
+**instant_message_id** | **String** |  | [optional] 
+**job_title** | **String** |  | [optional] 
+**location** | **String** |  | [optional] 
+**company** | [**Company**](Company.md) |  | [optional] 
+**mobile** | **String** |  | [optional] 
+**telephone** | **String** |  | [optional] 
+**user_status** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**email_notifications_enabled** | **BOOLEAN** |  | [optional] 
+**password** | **String** |  | [optional] 
+**old_password** | **String** |  | [optional] 
+**aspect_names** | **Array<String>** |  | [optional] 
+**properties** | **Hash<String, String>** |  | [optional] 
+
+

data/docs/PersonEntry.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::PersonEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**Person**](Person.md) |  | 
+
+

data/docs/PersonNetwork.md

@@ -0,0 +1,14 @@
+# AlfrescoAPI::PersonNetwork
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | This network's unique id | 
+**home_network** | **BOOLEAN** | Is this the home network? | [optional] 
+**is_enabled** | **BOOLEAN** |  | 
+**created_at** | **DateTime** |  | [optional] 
+**paid_network** | **BOOLEAN** |  | [optional] 
+**subscription_level** | **String** |  | [optional] 
+**quotas** | [**Array<NetworkQuota>**](NetworkQuota.md) |  | [optional] 
+
+

data/docs/PersonNetworkEntry.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::PersonNetworkEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**PersonNetwork**](PersonNetwork.md) |  | 
+
+

data/docs/PersonNetworkPaging.md

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

data/docs/PersonNetworkPagingList.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::PersonNetworkPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | 
+**entries** | [**Array<PersonNetworkEntry>**](PersonNetworkEntry.md) |  | 
+
+

data/docs/PersonPaging.md

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

data/docs/PersonPagingList.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::PersonPagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+**entries** | [**Array<PersonEntry>**](PersonEntry.md) |  | [optional] 
+
+

data/docs/Preference.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::Preference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique id of the preference | 
+**value** | **String** | The value of the preference. Note that this can be of any JSON type. | [optional] 
+
+

data/docs/PreferenceEntry.md

@@ -0,0 +1,8 @@
+# AlfrescoAPI::PreferenceEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry** | [**Preference**](Preference.md) |  | 
+
+

data/docs/PreferencePaging.md

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

data/docs/PreferencePagingList.md

@@ -0,0 +1,9 @@
+# AlfrescoAPI::PreferencePagingList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | 
+**entries** | [**Array<PreferenceEntry>**](PreferenceEntry.md) |  | 
+
+

data/docs/PreferencesApi.md

@@ -0,0 +1,131 @@
+# AlfrescoAPI::PreferencesApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_preference**](PreferencesApi.md#get_preference) | **GET** /people/{personId}/preferences/{preferenceName} | Get a preference
+[**list_preferences**](PreferencesApi.md#list_preferences) | **GET** /people/{personId}/preferences | List preferences
+
+
+# **get_preference**
+> PreferenceEntry get_preference(person_idpreference_name, opts)
+
+Get a preference
+
+Gets a specific preference for person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::PreferencesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+preference_name = "preference_name_example" # String | The name of the preference.
+
+opts = { 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Get a preference
+  result = api_instance.get_preference(person_idpreference_name, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling PreferencesApi->get_preference: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **preference_name** | **String**| The name of the preference. | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**PreferenceEntry**](PreferenceEntry.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_preferences**
+> PreferencePaging list_preferences(person_id, opts)
+
+List preferences
+
+Gets a list of preferences for person **personId**.  You can use the `-me-` string in place of `<personId>` to specify the currently authenticated user. Note that each preference consists of an **id** and a **value**.   The **value** can be of any JSON type. 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::PreferencesApi.new
+
+person_id = "person_id_example" # String | The identifier of a person.
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #List preferences
+  result = api_instance.list_preferences(person_id, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling PreferencesApi->list_preferences: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **person_id** | **String**| The identifier of a person. | 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**PreferencePaging**](PreferencePaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/QueriesApi.md

@@ -0,0 +1,206 @@
+# AlfrescoAPI::QueriesApi
+
+All URIs are relative to *https://localhost/alfresco/api/-default-/public/alfresco/versions/1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**find_nodes**](QueriesApi.md#find_nodes) | **GET** /queries/nodes | Find nodes
+[**find_people**](QueriesApi.md#find_people) | **GET** /queries/people | Find people
+[**find_sites**](QueriesApi.md#find_sites) | **GET** /queries/sites | Find sites
+
+
+# **find_nodes**
+> NodePaging find_nodes(term, opts)
+
+Find nodes
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets a list of nodes that match the given search criteria.  The search term is used to look for nodes that match against name, title, description, full text content or tags.  The search term: - must contain a minimum of 3 alphanumeric characters - allows \"quoted term\" - can optionally use '*' for wildcard matching  By default, file and folder types will be searched unless a specific type is provided as a query parameter.  By default, the search will be across the repository unless a specific root node id is provided to start the search from.  You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * name * modifiedAt * createdAt 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::QueriesApi.new
+
+term = "term_example" # String | The term to search for.
+
+opts = { 
+  root_node_id: "root_node_id_example", # String | The id of the node to start the search from.  Supports the aliases -my-, -root- and -shared-. 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  node_type: "node_type_example", # String | Restrict the returned results to only those of the given node type and its sub-types 
+  include: ["include_example"], # Array<String> | Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Find nodes
+  result = api_instance.find_nodes(term, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling QueriesApi->find_nodes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **term** | **String**| The term to search for. | 
+ **root_node_id** | **String**| The id of the node to start the search from.  Supports the aliases -my-, -root- and -shared-.  | [optional] 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **node_type** | **String**| Restrict the returned results to only those of the given node type and its sub-types  | [optional] 
+ **include** | [**Array&lt;String&gt;**](String.md)| Returns additional information about the node. The following optional fields can be requested: * allowableOperations * aspectNames * isLink * isLocked * path * properties  | [optional] 
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**NodePaging**](NodePaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_people**
+> PersonPaging find_people(term, opts)
+
+Find people
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets a list of people that match the given search criteria.  The search term is used to look for matches against person id, firstname and lastname.  The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term  You can sort the result list using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * firstName * lastName        
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::QueriesApi.new
+
+term = "term_example" # String | The term to search for. 
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+}
+
+begin
+  #Find people
+  result = api_instance.find_people(term, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling QueriesApi->find_people: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **term** | **String**| The term to search for.  | 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+
+### Return type
+
+[**PersonPaging**](PersonPaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **find_sites**
+> SitePaging find_sites(term, opts)
+
+Find sites
+
+**Note:** this endpoint is available in Alfresco 5.2 and newer versions.  Gets a list of sites that match the given search criteria.  The search term is used to look for sites that match against site id, title or description.  The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term  The default sort order for the returned list is for sites to be sorted by ascending id.  You can override the default by using the **orderBy** parameter. You can specify one or more of the following fields in the **orderBy** parameter: * id * title * description 
+
+### Example
+```ruby
+# load the gem
+require 'alfresco_api'
+# setup authorization
+AlfrescoAPI.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = AlfrescoAPI::QueriesApi.new
+
+term = "term_example" # String | The term to search for.
+
+opts = { 
+  skip_count: 0, # Integer | The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0. 
+  max_items: 100, # Integer | The maximum number of items to return in the list.  If not supplied then the default value is 100. 
+  order_by: ["order_by_example"], # Array<String> | A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field. 
+  fields: ["fields_example"] # Array<String> | A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. 
+}
+
+begin
+  #Find sites
+  result = api_instance.find_sites(term, opts)
+  p result
+rescue AlfrescoAPI::ApiError => e
+  puts "Exception when calling QueriesApi->find_sites: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **term** | **String**| The term to search for. | 
+ **skip_count** | **Integer**| The number of entities that exist in the collection before those included in this list.  If not supplied then the default value is 0.  | [optional] [default to 0]
+ **max_items** | **Integer**| The maximum number of items to return in the list.  If not supplied then the default value is 100.  | [optional] [default to 100]
+ **order_by** | [**Array&lt;String&gt;**](String.md)| A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields.  Each field has a default sort order, which is normally ascending order. Read the API method implementation notes above to check if any fields used in this method have a descending default search order.  To sort the entities in a specific order, you can use the **ASC** and **DESC** keywords for any field.  | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| A list of field names.  You can use this parameter to restrict the fields returned within a response if, for example, you want to save on overall bandwidth.  The list applies to a returned individual entity or entries within a collection.  If the API method also supports the **include** parameter, then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter.  | [optional] 
+
+### Return type
+
+[**SitePaging**](SitePaging.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+