# JReportServer.BVApi

All URIs are relative to *http://localhost:8888/jrserver/api/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteDimensionPermissionsOfBV**](BVApi.md#deleteDimensionPermissionsOfBV) | **DELETE** /BV/dimension/permissions | Delete group object permissions in a business view.
[**getBVAggregations**](BVApi.md#getBVAggregations) | **GET** /BV/aggregations | Get the aggregations in the business view.
[**getBVCategories**](BVApi.md#getBVCategories) | **GET** /BV/categories | Get the categories in the business view.
[**getBVDetails**](BVApi.md#getBVDetails) | **GET** /BV/details | Get the detail objects in the business view.
[**getBVDimension**](BVApi.md#getBVDimension) | **GET** /BV/dimension | Get the group object in the business view.
[**getBVDimensions**](BVApi.md#getBVDimensions) | **GET** /BV/dimensions | Get the group objects in the business view.
[**getBVsInCatalog**](BVApi.md#getBVsInCatalog) | **GET** /BVs | Get the business views in a catalog.
[**getDimensionPermission**](BVApi.md#getDimensionPermission) | **GET** /BV/dimension/permission | Get the permission of a group object.
[**getDimensionPermissionsOfBV**](BVApi.md#getDimensionPermissionsOfBV) | **GET** /BV/dimension/permissions | Get group object permissions in a business view.
[**setDimensionPermission**](BVApi.md#setDimensionPermission) | **PUT** /BV/dimension/permission | Set the permission of a group object.
[**setDimensionPermissionsOfBV**](BVApi.md#setDimensionPermissionsOfBV) | **PUT** /BV/dimension/permissions | Set group object permissions in a business view.


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

Delete group object permissions in a business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
  'principalType': "principalType_example", // String | The principal type.
  'principalName': "principalName_example" // String | The principal name.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 
 **principalType** | **String**| The principal type. | [optional] 
 **principalName** | **String**| The principal name. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="getBVAggregations"></a>
# **getBVAggregations**
> [BVElement] getBVAggregations(opts)

Get the aggregations in the business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[BVElement]**](BVElement.md)

### Authorization

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

### HTTP request headers

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

<a name="getBVCategories"></a>
# **getBVCategories**
> [BVElement] getBVCategories(opts)

Get the categories in the business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[BVElement]**](BVElement.md)

### Authorization

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

### HTTP request headers

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

<a name="getBVDetails"></a>
# **getBVDetails**
> [BVElement] getBVDetails(opts)

Get the detail objects in the business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[BVElement]**](BVElement.md)

### Authorization

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

### HTTP request headers

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

<a name="getBVDimension"></a>
# **getBVDimension**
> [DbValue] getBVDimension(opts)

Get the group object in the business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dimensionName': "dimensionName_example", // String | The name of the group object.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dimensionName** | **String**| The name of the group object. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[DbValue]**](DbValue.md)

### Authorization

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

### HTTP request headers

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

<a name="getBVDimensions"></a>
# **getBVDimensions**
> [BVElement] getBVDimensions(opts)

Get the group objects in the business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[BVElement]**](BVElement.md)

### Authorization

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

### HTTP request headers

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

<a name="getBVsInCatalog"></a>
# **getBVsInCatalog**
> [BV] getBVsInCatalog(opts)

Get the business views in a catalog.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 

### Return type

[**[BV]**](BV.md)

### Authorization

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

### HTTP request headers

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

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

Get the permission of a group object.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'dimensionName': "dimensionName_example", // String | The name of the group object.
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
  'principalType': "principalType_example", // String | The principal type.
  'principalName': "principalName_example" // String | The principal name.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **dimensionName** | **String**| The name of the group object. | [optional] 
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 
 **principalType** | **String**| The principal type. | [optional] 
 **principalName** | **String**| The principal name. | [optional] 

### Return type

[**DimensionPermission**](DimensionPermission.md)

### Authorization

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

### HTTP request headers

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

<a name="getDimensionPermissionsOfBV"></a>
# **getDimensionPermissionsOfBV**
> [DimensionPermission] getDimensionPermissionsOfBV(opts)

Get group object permissions in a business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
  'principalType': "principalType_example", // String | The principal type.
  'principalName': "principalName_example" // String | The principal name.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 
 **principalType** | **String**| The principal type. | [optional] 
 **principalName** | **String**| The principal name. | [optional] 

### Return type

[**[DimensionPermission]**](DimensionPermission.md)

### Authorization

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

### HTTP request headers

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

<a name="setDimensionPermission"></a>
# **setDimensionPermission**
> setDimensionPermission(bvPermissions, opts)

Set the permission of a group object.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var bvPermissions = new JReportServer.DimensionPermission(); // DimensionPermission | Business view permissions.

var opts = { 
  'dimensionName': "dimensionName_example", // String | The name of the group object.
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
  'principalType': "principalType_example", // String | The principal type.
  'principalName': "principalName_example" // String | The principal name.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvPermissions** | [**DimensionPermission**](DimensionPermission.md)| Business view permissions. | 
 **dimensionName** | **String**| The name of the group object. | [optional] 
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 
 **principalType** | **String**| The principal type. | [optional] 
 **principalName** | **String**| The principal name. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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

<a name="setDimensionPermissionsOfBV"></a>
# **setDimensionPermissionsOfBV**
> setDimensionPermissionsOfBV(bvPermissions, opts)

Set group object permissions in a business view.



### Example
```javascript
var JReportServer = require('j_report_server');
var defaultClient = JReportServer.ApiClient.instance;

// Configure HTTP basic authorization: user_auth
var user_auth = defaultClient.authentications['user_auth'];
user_auth.username = 'YOUR USERNAME';
user_auth.password = 'YOUR PASSWORD';

var apiInstance = new JReportServer.BVApi();

var bvPermissions = [new JReportServer.DimensionPermission()]; // [DimensionPermission] | Business view permissions.

var opts = { 
  'bvName': "bvName_example", // String | The business view name.
  'dsName': "dsName_example", // String | The data source name.
  'path': "path_example", // String | The server resource path.
  'versionNumber': 56, // Number | The version number. -1 means the latest version; 0 means that this parameter is ignored.
  'principalType': "principalType_example", // String | The principal type.
  'principalName': "principalName_example" // String | The principal name.
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **bvPermissions** | [**[DimensionPermission]**](DimensionPermission.md)| Business view permissions. | 
 **bvName** | **String**| The business view name. | [optional] 
 **dsName** | **String**| The data source name. | [optional] 
 **path** | **String**| The server resource path. | [optional] 
 **versionNumber** | **Number**| The version number. -1 means the latest version; 0 means that this parameter is ignored. | [optional] 
 **principalType** | **String**| The principal type. | [optional] 
 **principalName** | **String**| The principal name. | [optional] 

### Return type

null (empty response body)

### Authorization

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

### HTTP request headers

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