# entity_api

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
****](entity_api.md#) | **GET** /entities/{entityId}/changes | Sync changes from data source
****](entity_api.md#) | **POST** /entities/{entityId}/changes | Sync changes from data source
****](entity_api.md#) | **GET** /entities/{entityId}/next-sync | Next sync
****](entity_api.md#) | **PUT** /entities/{entityId}/next-sync | Next sync
****](entity_api.md#) | **PUT** /entities/{entityId} | Update entity
****](entity_api.md#) | **GET** /entities | List entities


# ****
> models::DataSource (entity_id)
Sync changes from data source

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **entity_id** | **String**| Id of the entity | 

### Return type

[**models::DataSource**](DataSource.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, 

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# ****
> models::DataSource (entity_id, optional)
Sync changes from data source

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **entity_id** | **String**| Id of the entity | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **entity_id** | **String**| Id of the entity | 
 **data_source** | [**DataSource**](DataSource.md)|  | 

### Return type

[**models::DataSource**](DataSource.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json, 

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# ****
> models::EntityNextSync (entity_id)
Next sync

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **entity_id** | **String**| Id of the entity | 

### Return type

[**models::EntityNextSync**](EntityNextSync.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, 

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# ****
> (entity_id, optional)
Next sync

This endpoint acts as a confirmation for a successful synchronization. When called, it will record the current timestamp, and use to calculate when next synchronization should occur.

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **entity_id** | **String**| Id of the entity | 
 **optional** | **map[string]interface{}** | optional parameters | nil if no parameters

### Optional Parameters
Optional parameters are passed through a map[string]interface{}.

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **entity_id** | **String**| Id of the entity | 
 **body** | **String**|  | 

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# ****
> models::EntitySettings (entity_id)
Update entity

### Required Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
  **entity_id** | **String**| Id of the entity | 

### Return type

[**models::EntitySettings**](EntitySettings.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, 

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# ****
> models::EntitySettings ()
List entities

### Required Parameters
This endpoint does not need any parameter.

### Return type

[**models::EntitySettings**](EntitySettings.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)