# VmosoApi.HistoryApi

All URIs are relative to *https://www.vmoso.com/svc*

Method | HTTP request | Description
------------- | ------------- | -------------
[**pinHistoryEntry**](HistoryApi.md#pinHistoryEntry) | **POST** /history/pin | 
[**recordHistoryEntry**](HistoryApi.md#recordHistoryEntry) | **POST** /history | 
[**unpinHistoryEntry**](HistoryApi.md#unpinHistoryEntry) | **POST** /history/unpin | 


<a name="pinHistoryEntry"></a>
# **pinHistoryEntry**
> PinHistoryEntryResult pinHistoryEntry(input)



Use this API to pin history.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.HistoryApi()

var input = new VmosoApi.PinHistoryEntryInput(); // {PinHistoryEntryInput} History ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.pinHistoryEntry(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**PinHistoryEntryInput**](PinHistoryEntryInput.md)| History ID. | 

### Return type

[**PinHistoryEntryResult**](PinHistoryEntryResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

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

<a name="recordHistoryEntry"></a>
# **recordHistoryEntry**
> RecordHistoryEntryResult recordHistoryEntry(input)



Use this API to get the history for Vmoso objects.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.HistoryApi()

var input = new VmosoApi.RecordHistoryEntryInput(); // {RecordHistoryEntryInput} History selection and pagination preferences.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.recordHistoryEntry(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**RecordHistoryEntryInput**](RecordHistoryEntryInput.md)| History selection and pagination preferences. | 

### Return type

[**RecordHistoryEntryResult**](RecordHistoryEntryResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

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

<a name="unpinHistoryEntry"></a>
# **unpinHistoryEntry**
> UnpinHistoryEntryResult unpinHistoryEntry(input)



Use this API to unpin history.

### Example
```javascript
var VmosoApi = require('vmoso-api');
var defaultClient = VmosoApi.ApiClient.default;

// Configure API key authorization: vmoso_auth
var vmoso_auth = defaultClient.authentications['vmoso_auth'];
vmoso_auth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//vmoso_auth.apiKeyPrefix['X-CV-Authorization'] = "Token"

var apiInstance = new VmosoApi.HistoryApi()

var input = new VmosoApi.UnpinHistoryEntryInput(); // {UnpinHistoryEntryInput} History ID.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.unpinHistoryEntry(input, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **input** | [**UnpinHistoryEntryInput**](UnpinHistoryEntryInput.md)| History ID. | 

### Return type

[**UnpinHistoryEntryResult**](UnpinHistoryEntryResult.md)

### Authorization

[vmoso_auth](../README.md#vmoso_auth)

### HTTP reuqest headers

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