# XgeneCloud.CofroleApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**addcofRole**](CofroleApi.md#addcofRole) | **POST** /api/v1/cof_role | Add a new cof_role
[**bulkcofRoleInsert**](CofroleApi.md#bulkcofRoleInsert) | **POST** /api/v1/cof_role/bulk | Bulk cof_role insert
[**checkcofRoleExists**](CofroleApi.md#checkcofRoleExists) | **GET** /api/v1/cof_role/{cof_roleId}/exists | Check cof_role with provided ID exists
[**cofRoleAggregate**](CofroleApi.md#cofRoleAggregate) | **GET** /api/v1/cof_role/aggregate/{columnName} | Get first one from filtered data
[**cofRoleDistinct**](CofroleApi.md#cofRoleDistinct) | **GET** /api/v1/cof_role/distinct/{columnName} | Get first one from filtered data
[**cofRoleDistribution**](CofroleApi.md#cofRoleDistribution) | **GET** /api/v1/cof_role/distribution/{columnName} | 
[**cofRoleGroupByColumn**](CofroleApi.md#cofRoleGroupByColumn) | **GET** /api/v1/cof_role/groupby/{columnName} | Group by column
[**deletecofRole**](CofroleApi.md#deletecofRole) | **DELETE** /api/v1/cof_role/bulk | Deletes a cof_role
[**deletecofRole_0**](CofroleApi.md#deletecofRole_0) | **DELETE** /api/v1/cof_role/{cof_roleId} | Deletes a cof_role
[**findOnecofRole**](CofroleApi.md#findOnecofRole) | **GET** /api/v1/cof_role/findOne | Get first one from filtered data
[**getcofRole**](CofroleApi.md#getcofRole) | **GET** /api/v1/cof_role | Get list
[**getcofRoleById**](CofroleApi.md#getcofRoleById) | **GET** /api/v1/cof_role/{cof_roleId} | Find cof_role by ID
[**getcofRoleCount**](CofroleApi.md#getcofRoleCount) | **GET** /api/v1/cof_role/count | Get cof_role count
[**updatecofRole**](CofroleApi.md#updatecofRole) | **PUT** /api/v1/cof_role/bulk | Updates a cof_role
[**updatecofRole_0**](CofroleApi.md#updatecofRole_0) | **PUT** /api/v1/cof_role/{cof_roleId} | Updates a cof_role


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

Add a new cof_role



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

var apiInstance = new XgeneCloud.CofroleApi();

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CofRole**](CofRole.md)| cof_role 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="bulkcofRoleInsert"></a>
# **bulkcofRoleInsert**
> bulkcofRoleInsert(body)

Bulk cof_role insert



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

var apiInstance = new XgeneCloud.CofroleApi();

var body = [new XgeneCloud.CofRole()]; // [CofRole] | cof_role objects


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofRole]**](CofRole.md)| cof_role objects | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

<a name="checkcofRoleExists"></a>
# **checkcofRoleExists**
> &#39;Boolean&#39; checkcofRoleExists(cofRoleId)

Check cof_role with provided ID exists

Returns a single cof_role

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

var apiInstance = new XgeneCloud.CofroleApi();

var cofRoleId = 789; // Integer | ID of cof_role


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofRoleId** | **Integer**| ID of cof_role | 

### Return type

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

### Authorization

No authorization required

### HTTP request headers

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

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

Get first one from filtered data



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

var apiInstance = new XgeneCloud.CofroleApi();

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.cofRoleAggregate(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

[**CofRole**](CofRole.md)

### Authorization

No authorization required

### HTTP request headers

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

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

Get first one from filtered data



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

var apiInstance = new XgeneCloud.CofroleApi();

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.cofRoleDistinct(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="cofRoleDistribution"></a>
# **cofRoleDistribution**
> [Object] cofRoleDistribution(columnName, opts)





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

var apiInstance = new XgeneCloud.CofroleApi();

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.cofRoleDistribution(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="cofRoleGroupByColumn"></a>
# **cofRoleGroupByColumn**
> CofRole cofRoleGroupByColumn(columnName, opts)

Group by column



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

var apiInstance = new XgeneCloud.CofroleApi();

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.cofRoleGroupByColumn(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

[**CofRole**](CofRole.md)

### Authorization

No authorization required

### HTTP request headers

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

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

Deletes a cof_role



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

var apiInstance = new XgeneCloud.CofroleApi();

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofRole]**](CofRole.md)| cof_role 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="deletecofRole_0"></a>
# **deletecofRole_0**
> deletecofRole_0(cofRoleId)

Deletes a cof_role



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

var apiInstance = new XgeneCloud.CofroleApi();

var cofRoleId = 789; // Integer | ID of cof_role to return


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofRoleId** | **Integer**| ID of cof_role to return | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

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

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

Get first one from filtered data



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

var apiInstance = new XgeneCloud.CofroleApi();

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.findOnecofRole(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

[**CofRole**](CofRole.md)

### Authorization

No authorization required

### HTTP request headers

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

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

Get list



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

var apiInstance = new XgeneCloud.CofroleApi();

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.getcofRole(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="getcofRoleById"></a>
# **getcofRoleById**
> CofRole getcofRoleById(cofRoleId)

Find cof_role by ID

Returns a single cof_role

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

var apiInstance = new XgeneCloud.CofroleApi();

var cofRoleId = 789; // Integer | ID of cof_role to return


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofRoleId** | **Integer**| ID of cof_role to return | 

### Return type

[**CofRole**](CofRole.md)

### Authorization

No authorization required

### HTTP request headers

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

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

Get cof_role count

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

var apiInstance = new XgeneCloud.CofroleApi();

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.getcofRoleCount(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="updatecofRole"></a>
# **updatecofRole**
> updatecofRole(body)

Updates a cof_role



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

var apiInstance = new XgeneCloud.CofroleApi();

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


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**[CofRole]**](CofRole.md)| cof_role 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="updatecofRole_0"></a>
# **updatecofRole_0**
> updatecofRole_0(cofRoleId, body)

Updates a cof_role



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

var apiInstance = new XgeneCloud.CofroleApi();

var cofRoleId = 789; // Integer | ID of cof_role to return

var body = new XgeneCloud.CofRole(); // CofRole | cof_role 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.updatecofRole_0(cofRoleId, body, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **cofRoleId** | **Integer**| ID of cof_role to return | 
 **body** | [**CofRole**](CofRole.md)| cof_role 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