# XgeneCloud.CofdimensionApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addcofDimension**](CofdimensionApi.md#addcofDimension) | **POST** /api/v1/cof_dimension | Add a new cof_dimension
[**bulkcofDimensionInsert**](CofdimensionApi.md#bulkcofDimensionInsert) | **POST** /api/v1/cof_dimension/bulk | Bulk cof_dimension insert
[**checkcofDimensionExists**](CofdimensionApi.md#checkcofDimensionExists) | **GET** /api/v1/cof_dimension/{cof_dimensionId}/exists | Check cof_dimension with provided ID exists
[**cofDimensionAggregate**](CofdimensionApi.md#cofDimensionAggregate) | **GET** /api/v1/cof_dimension/aggregate/{columnName} | Get first one from filtered data
[**cofDimensionDistinct**](CofdimensionApi.md#cofDimensionDistinct) | **GET** /api/v1/cof_dimension/distinct/{columnName} | Get first one from filtered data
[**cofDimensionDistribution**](CofdimensionApi.md#cofDimensionDistribution) | **GET** /api/v1/cof_dimension/distribution/{columnName} | 
[**cofDimensionGroupByColumn**](CofdimensionApi.md#cofDimensionGroupByColumn) | **GET** /api/v1/cof_dimension/groupby/{columnName} | Group by column
[**deletecofDimension**](CofdimensionApi.md#deletecofDimension) | **DELETE** /api/v1/cof_dimension/bulk | Deletes a cof_dimension
[**deletecofDimension_0**](CofdimensionApi.md#deletecofDimension_0) | **DELETE** /api/v1/cof_dimension/{cof_dimensionId} | Deletes a cof_dimension
[**findOnecofDimension**](CofdimensionApi.md#findOnecofDimension) | **GET** /api/v1/cof_dimension/findOne | Get first one from filtered data
[**getcofDimension**](CofdimensionApi.md#getcofDimension) | **GET** /api/v1/cof_dimension | Get list
[**getcofDimensionById**](CofdimensionApi.md#getcofDimensionById) | **GET** /api/v1/cof_dimension/{cof_dimensionId} | Find cof_dimension by ID
[**getcofDimensionCount**](CofdimensionApi.md#getcofDimensionCount) | **GET** /api/v1/cof_dimension/count | Get cof_dimension count
[**updatecofDimension**](CofdimensionApi.md#updatecofDimension) | **PUT** /api/v1/cof_dimension/bulk | Updates a cof_dimension
[**updatecofDimension_0**](CofdimensionApi.md#updatecofDimension_0) | **PUT** /api/v1/cof_dimension/{cof_dimensionId} | Updates a cof_dimension


<a name="addcofDimension"></a>
# **addcofDimension**
> addcofDimension(body)

Add a new cof_dimension



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var body = new XgeneCloud.CofDimension(); // CofDimension | cof_dimension object that needs to add


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addcofDimension(body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CofDimension**](CofDimension.md)| cof_dimension object that needs to add | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="bulkcofDimensionInsert"></a>
# **bulkcofDimensionInsert**
> bulkcofDimensionInsert(body)

Bulk cof_dimension insert



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var body = [new XgeneCloud.CofDimension()]; // [CofDimension] | cof_dimension objects


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.bulkcofDimensionInsert(body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofDimension]**](CofDimension.md)| cof_dimension objects | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="checkcofDimensionExists"></a>
# **checkcofDimensionExists**
> &#39;Boolean&#39; checkcofDimensionExists(cofDimensionId)

Check cof_dimension with provided ID exists

Returns a single cof_dimension

### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var cofDimensionId = 789; // Integer | ID of cof_dimension


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofDimensionId** | **Integer**| ID of cof_dimension | 

### Return type

**&#39;Boolean&#39;**

### Authorization

No authorization required

### HTTP request headers

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

<a name="cofDimensionAggregate"></a>
# **cofDimensionAggregate**
> CofDimension cofDimensionAggregate(columnName, fields, func, opts)

Get first one from filtered data



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var columnName = "columnName_example"; // String | Column name

var fields = "fields_example"; // String | Column name

var func = "func_example"; // String | Comma seperated aggregate functions

var opts = { 
  'having': "having_example", // String | Having expression
  'fields2': "fields_example", // String | Comma seperated fields from the model
  'limit': 789, // Integer | Page size limit
  'offset': 789, // Integer | Pagination offset
  'sort': "sort_example" // String | Comma seperated sort fields
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.cofDimensionAggregate(columnName, fields, func, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **columnName** | **String**| Column name | 
 **fields** | **String**| Column name | 
 **func** | **String**| Comma seperated aggregate functions | 
 **having** | **String**| Having expression | [optional] 
 **fields2** | **String**| Comma seperated fields from the model | [optional] 
 **limit** | **Integer**| Page size limit | [optional] 
 **offset** | **Integer**| Pagination offset | [optional] 
 **sort** | **String**| Comma seperated sort fields | [optional] 

### Return type

[**CofDimension**](CofDimension.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="cofDimensionDistinct"></a>
# **cofDimensionDistinct**
> [Object] cofDimensionDistinct(columnName, opts)

Get first one from filtered data



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var columnName = "columnName_example"; // String | Column name

var opts = { 
  'where': "where_example", // String | Where expression
  'limit': 789, // Integer | Page size limit
  'offset': 789, // Integer | Pagination offset
  'sort': "sort_example" // String | Comma seperated sort fieldst
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.cofDimensionDistinct(columnName, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **columnName** | **String**| Column name | 
 **where** | **String**| Where expression | [optional] 
 **limit** | **Integer**| Page size limit | [optional] 
 **offset** | **Integer**| Pagination offset | [optional] 
 **sort** | **String**| Comma seperated sort fieldst | [optional] 

### Return type

**[Object]**

### Authorization

No authorization required

### HTTP request headers

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

<a name="cofDimensionDistribution"></a>
# **cofDimensionDistribution**
> [Object] cofDimensionDistribution(columnName, opts)





### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var columnName = "columnName_example"; // String | Column name

var opts = { 
  'min': 789, // Integer | min value
  'max': 789, // Integer | max value
  'step': 789, // Integer | step value
  'steps': 789, // Integer | steps value
  'func': "func_example" // String | comma separated aggregation functions
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.cofDimensionDistribution(columnName, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **columnName** | **String**| Column name | 
 **min** | **Integer**| min value | [optional] 
 **max** | **Integer**| max value | [optional] 
 **step** | **Integer**| step value | [optional] 
 **steps** | **Integer**| steps value | [optional] 
 **func** | **String**| comma separated aggregation functions | [optional] 

### Return type

**[Object]**

### Authorization

No authorization required

### HTTP request headers

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

<a name="cofDimensionGroupByColumn"></a>
# **cofDimensionGroupByColumn**
> CofDimension cofDimensionGroupByColumn(columnName, opts)

Group by column



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var columnName = "columnName_example"; // String | Column name

var opts = { 
  'where': "where_example", // String | Where expression
  'limit': 789, // Integer | Page size limit
  'offset': 789, // Integer | Pagination offset
  'sort': "sort_example" // String | Comma seperated sort fieldst
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.cofDimensionGroupByColumn(columnName, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **columnName** | **String**| Column name | 
 **where** | **String**| Where expression | [optional] 
 **limit** | **Integer**| Page size limit | [optional] 
 **offset** | **Integer**| Pagination offset | [optional] 
 **sort** | **String**| Comma seperated sort fieldst | [optional] 

### Return type

[**CofDimension**](CofDimension.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deletecofDimension"></a>
# **deletecofDimension**
> deletecofDimension(body)

Deletes a cof_dimension



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var body = [new XgeneCloud.CofDimension()]; // [CofDimension] | cof_dimension objects contains id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deletecofDimension(body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofDimension]**](CofDimension.md)| cof_dimension objects contains id | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="deletecofDimension_0"></a>
# **deletecofDimension_0**
> deletecofDimension_0(cofDimensionId)

Deletes a cof_dimension



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var cofDimensionId = 789; // Integer | ID of cof_dimension to return


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.deletecofDimension_0(cofDimensionId, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofDimensionId** | **Integer**| ID of cof_dimension to return | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="findOnecofDimension"></a>
# **findOnecofDimension**
> CofDimension findOnecofDimension(opts)

Get first one from filtered data



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var opts = { 
  'fields': "fields_example", // String | Comma seperated fields from the model
  'where': "where_example", // String | Where expression
  'limit': 789, // Integer | Page size limit
  'offset': 789, // Integer | Pagination offset
  'sort': "sort_example" // String | Comma seperated sort fieldst
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **fields** | **String**| Comma seperated fields from the model | [optional] 
 **where** | **String**| Where expression | [optional] 
 **limit** | **Integer**| Page size limit | [optional] 
 **offset** | **Integer**| Pagination offset | [optional] 
 **sort** | **String**| Comma seperated sort fieldst | [optional] 

### Return type

[**CofDimension**](CofDimension.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getcofDimension"></a>
# **getcofDimension**
> getcofDimension(opts)

Get list



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var opts = { 
  'fields': "fields_example", // String | Comma seperated fields from the model
  'where': "where_example", // String | Where expression
  'limit': 789, // Integer | Page size limit
  'offset': 789, // Integer | Pagination offset
  'sort': "sort_example" // String | Comma seperated sort fields
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getcofDimension(opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **fields** | **String**| Comma seperated fields from the model | [optional] 
 **where** | **String**| Where expression | [optional] 
 **limit** | **Integer**| Page size limit | [optional] 
 **offset** | **Integer**| Pagination offset | [optional] 
 **sort** | **String**| Comma seperated sort fields | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getcofDimensionById"></a>
# **getcofDimensionById**
> CofDimension getcofDimensionById(cofDimensionId)

Find cof_dimension by ID

Returns a single cof_dimension

### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var cofDimensionId = 789; // Integer | ID of cof_dimension to return


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofDimensionId** | **Integer**| ID of cof_dimension to return | 

### Return type

[**CofDimension**](CofDimension.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getcofDimensionCount"></a>
# **getcofDimensionCount**
> Object getcofDimensionCount(opts)

Get cof_dimension count

### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var opts = { 
  'where': "where_example" // String | Where expression
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **where** | **String**| Where expression | [optional] 

### Return type

**Object**

### Authorization

No authorization required

### HTTP request headers

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

<a name="updatecofDimension"></a>
# **updatecofDimension**
> updatecofDimension(body)

Updates a cof_dimension



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var body = [new XgeneCloud.CofDimension()]; // [CofDimension] | cof_dimension objects with id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updatecofDimension(body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofDimension]**](CofDimension.md)| cof_dimension objects with id | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="updatecofDimension_0"></a>
# **updatecofDimension_0**
> updatecofDimension_0(cofDimensionId, body)

Updates a cof_dimension



### Example
```javascript
var XgeneCloud = require('xgene_cloud');

var apiInstance = new XgeneCloud.CofdimensionApi();

var cofDimensionId = 789; // Integer | ID of cof_dimension to return

var body = new XgeneCloud.CofDimension(); // CofDimension | cof_dimension object that needs to be added to the store


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updatecofDimension_0(cofDimensionId, body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofDimensionId** | **Integer**| ID of cof_dimension to return | 
 **body** | [**CofDimension**](CofDimension.md)| cof_dimension object that needs to be added to the store | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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