DatasetsApi

All URIs are relative to https://api.powerbi.com

Method	HTTP request	Description
bindToGateway	POST /v1.0/myorg/datasets/{datasetKey}/Default.BindToGateway	Bind dataset to gateway
bindToGatewayInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/Default.BindToGateway	Bind dataset to gateway
deleteDatasetById	DELETE /v1.0/myorg/datasets/{datasetKey}	Deletes the dataset with the specified id
deleteDatasetByIdInGroup	DELETE /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}	Deletes the dataset with the specified id
deleteRows	DELETE /v1.0/myorg/datasets/{datasetKey}/tables/{tableName}/rows	Deletes all rows from the specified table
deleteRowsInGroup	DELETE /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/tables/{tableName}/rows	Deletes all rows from the specified table
generateTokenInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/GenerateToken	Generate token to view the specified dataset
getDatasetById	GET /v1.0/myorg/datasets/{datasetKey}	Gets the dataset metadata for the specifeid dataset id
getDatasetByIdInGroup	GET /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}	Gets the dataset metadata for the specifeid dataset id
getDatasets	GET /v1.0/myorg/datasets	Returns the datasets
getDatasetsInGroup	GET /v1.0/myorg/groups/{groupId}/datasets	Returns the datasets
getDatasources	GET /v1.0/myorg/datasets/{datasetKey}/datasources	Gets a list of datasource for the specified dataset
getDatasourcesInGroup	GET /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/datasources	Gets a list of datasource for the specified dataset
getGatewayDatasources	GET /v1.0/myorg/datasets/{datasetKey}/Default.GetBoundGatewayDatasources	Gets a list of bound gateway datasources for the specified dataset
getGatewayDatasourcesInGroup	GET /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/Default.GetBoundGatewayDatasources	Gets a list of bound gateway datasources for the specified dataset
getRefreshHistory	GET /v1.0/myorg/datasets/{datasetKey}/refreshes	Gets the dataset refresh history
getRefreshHistoryInGroup	GET /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/refreshes	Gets the dataset refresh history
getTables	GET /v1.0/myorg/datasets/{datasetKey}/tables	Gets all tables within the specified dataset
getTablesInGroup	GET /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/tables	Gets all tables within the specified dataset
postDataset	POST /v1.0/myorg/datasets	Post a new entity to datasets
postDatasetInGroup	POST /v1.0/myorg/groups/{groupId}/datasets	Post a new entity to datasets
postRows	POST /v1.0/myorg/datasets/{datasetKey}/tables/{tableName}/rows	Posts new data rows into the specified table
postRowsInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/tables/{tableName}/rows	Posts new data rows into the specified table
putTable	PUT /v1.0/myorg/datasets/{datasetKey}/tables/{tableName}	Updates a schema and metadata for the specified table
putTableInGroup	PUT /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/tables/{tableName}	Updates a schema and metadata for the specified table
refreshDataset	POST /v1.0/myorg/datasets/{datasetKey}/refreshes	Start a dataset refresh
refreshDatasetInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/refreshes	Start a dataset refresh
setAllDatasetConnections	POST /v1.0/myorg/datasets/{datasetKey}/Default.SetAllConnections	Sets all connections for the specified dataset
setAllDatasetConnectionsInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/Default.SetAllConnections	Sets all connections for the specified dataset
takeOverInGroup	POST /v1.0/myorg/groups/{groupId}/datasets/{datasetKey}/Default.TakeOver	Take Over a dataset

bindToGateway

Object bindToGateway(datasetKey, bindToGatewayRequest)

Bind dataset to gateway

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
BindToGatewayRequest bindToGatewayRequest = new BindToGatewayRequest(); // BindToGatewayRequest | The bind to gateway request
try {
    Object result = apiInstance.bindToGateway(datasetKey, bindToGatewayRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#bindToGateway");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id
bindToGatewayRequest	BindToGatewayRequest	The bind to gateway request

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

bindToGatewayInGroup

Object bindToGatewayInGroup(groupId, datasetKey, bindToGatewayRequest)

Bind dataset to gateway

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
BindToGatewayRequest bindToGatewayRequest = new BindToGatewayRequest(); // BindToGatewayRequest | The bind to gateway request
try {
    Object result = apiInstance.bindToGatewayInGroup(groupId, datasetKey, bindToGatewayRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#bindToGatewayInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
bindToGatewayRequest	BindToGatewayRequest	The bind to gateway request

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

deleteDatasetById

Object deleteDatasetById(datasetKey)

Deletes the dataset with the specified id

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Object result = apiInstance.deleteDatasetById(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#deleteDatasetById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteDatasetByIdInGroup

Object deleteDatasetByIdInGroup(groupId, datasetKey)

Deletes the dataset with the specified id

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Object result = apiInstance.deleteDatasetByIdInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#deleteDatasetByIdInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteRows

Object deleteRows(datasetKey, tableName)

Deletes all rows from the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
try {
    Object result = apiInstance.deleteRows(datasetKey, tableName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#deleteRows");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id
tableName	String	The table name

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

deleteRowsInGroup

Object deleteRowsInGroup(groupId, datasetKey, tableName)

Deletes all rows from the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
try {
    Object result = apiInstance.deleteRowsInGroup(groupId, datasetKey, tableName);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#deleteRowsInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
tableName	String	The table name

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

generateTokenInGroup

EmbedToken generateTokenInGroup(groupId, datasetKey, requestParameters)

Generate token to view the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
GenerateTokenRequest requestParameters = new GenerateTokenRequest(); // GenerateTokenRequest | Generate token parameters
try {
    EmbedToken result = apiInstance.generateTokenInGroup(groupId, datasetKey, requestParameters);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#generateTokenInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
requestParameters	GenerateTokenRequest	Generate token parameters

Return type

EmbedToken

Authorization

No authorization required

HTTP request headers

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

getDatasetById

Dataset getDatasetById(datasetKey)

Gets the dataset metadata for the specifeid dataset id

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Dataset result = apiInstance.getDatasetById(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasetById");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id

Return type

Dataset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDatasetByIdInGroup

Dataset getDatasetByIdInGroup(groupId, datasetKey)

Gets the dataset metadata for the specifeid dataset id

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Dataset result = apiInstance.getDatasetByIdInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasetByIdInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

Dataset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDatasets

ODataResponseListDataset getDatasets()

Returns the datasets

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
try {
    ODataResponseListDataset result = apiInstance.getDatasets();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasets");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ODataResponseListDataset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDatasetsInGroup

ODataResponseListDataset getDatasetsInGroup(groupId)

Returns the datasets

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
try {
    ODataResponseListDataset result = apiInstance.getDatasetsInGroup(groupId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasetsInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id

Return type

ODataResponseListDataset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDatasources

ODataResponseListDatasource getDatasources(datasetKey)

Gets a list of datasource for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | 
try {
    ODataResponseListDatasource result = apiInstance.getDatasources(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasources");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String

Return type

ODataResponseListDatasource

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getDatasourcesInGroup

ODataResponseListDatasource getDatasourcesInGroup(groupId, datasetKey)

Gets a list of datasource for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | 
try {
    ODataResponseListDatasource result = apiInstance.getDatasourcesInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getDatasourcesInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String

Return type

ODataResponseListDatasource

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getGatewayDatasources

ODataResponseListGatewayDatasource getGatewayDatasources(datasetKey)

Gets a list of bound gateway datasources for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    ODataResponseListGatewayDatasource result = apiInstance.getGatewayDatasources(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getGatewayDatasources");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id

Return type

ODataResponseListGatewayDatasource

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getGatewayDatasourcesInGroup

ODataResponseListGatewayDatasource getGatewayDatasourcesInGroup(groupId, datasetKey)

Gets a list of bound gateway datasources for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    ODataResponseListGatewayDatasource result = apiInstance.getGatewayDatasourcesInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getGatewayDatasourcesInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

ODataResponseListGatewayDatasource

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getRefreshHistory

ODataResponseListRefresh getRefreshHistory(datasetKey, top)

Gets the dataset refresh history

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
Integer top = 56; // Integer | The requested number of entries in the refresh history, if not supported the default is all available entries
try {
    ODataResponseListRefresh result = apiInstance.getRefreshHistory(datasetKey, top);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getRefreshHistory");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id
top	Integer	The requested number of entries in the refresh history, if not supported the default is all available entries	[optional]

Return type

ODataResponseListRefresh

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getRefreshHistoryInGroup

ODataResponseListRefresh getRefreshHistoryInGroup(groupId, datasetKey, top)

Gets the dataset refresh history

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
Integer top = 56; // Integer | The requested number of entries in the refresh history, if not supported the default is all available entries
try {
    ODataResponseListRefresh result = apiInstance.getRefreshHistoryInGroup(groupId, datasetKey, top);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getRefreshHistoryInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id
top	Integer	The requested number of entries in the refresh history, if not supported the default is all available entries	[optional]

Return type

ODataResponseListRefresh

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTables

ODataResponseListTable getTables(datasetKey)

Gets all tables within the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    ODataResponseListTable result = apiInstance.getTables(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getTables");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id

Return type

ODataResponseListTable

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getTablesInGroup

ODataResponseListTable getTablesInGroup(groupId, datasetKey)

Gets all tables within the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    ODataResponseListTable result = apiInstance.getTablesInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#getTablesInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

ODataResponseListTable

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

postDataset

Dataset postDataset(dataset)

Post a new entity to datasets

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
Dataset dataset = new Dataset(); // Dataset | Create dataset parameters
try {
    Dataset result = apiInstance.postDataset(dataset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#postDataset");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
dataset	Dataset	Create dataset parameters

Return type

Dataset

Authorization

No authorization required

HTTP request headers

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

postDatasetInGroup

Dataset postDatasetInGroup(groupId, dataset)

Post a new entity to datasets

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
Dataset dataset = new Dataset(); // Dataset | Create dataset parameters
try {
    Dataset result = apiInstance.postDatasetInGroup(groupId, dataset);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#postDatasetInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
dataset	Dataset	Create dataset parameters

Return type

Dataset

Authorization

No authorization required

HTTP request headers

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

postRows

Object postRows(datasetKey, tableName, requestMessage)

Posts new data rows into the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
Object requestMessage = null; // Object | The request message
try {
    Object result = apiInstance.postRows(datasetKey, tableName, requestMessage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#postRows");
    e.printStackTrace();
}

Parameters

Name	Type	Description
datasetKey	String	The dataset id
tableName	String	The table name
requestMessage	Object	The request message

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

postRowsInGroup

Object postRowsInGroup(groupId, datasetKey, tableName, requestMessage)

Posts new data rows into the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
Object requestMessage = null; // Object | The request message
try {
    Object result = apiInstance.postRowsInGroup(groupId, datasetKey, tableName, requestMessage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#postRowsInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
tableName	String	The table name
requestMessage	Object	The request message

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

putTable

Object putTable(datasetKey, tableName, requestMessage)

Updates a schema and metadata for the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
Object requestMessage = null; // Object | The request message
try {
    Object result = apiInstance.putTable(datasetKey, tableName, requestMessage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#putTable");
    e.printStackTrace();
}

Parameters

Name	Type	Description
datasetKey	String	The dataset id
tableName	String	The table name
requestMessage	Object	The request message

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

putTableInGroup

Object putTableInGroup(groupId, datasetKey, tableName, requestMessage)

Updates a schema and metadata for the specified table

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
String tableName = "tableName_example"; // String | The table name
Object requestMessage = null; // Object | The request message
try {
    Object result = apiInstance.putTableInGroup(groupId, datasetKey, tableName, requestMessage);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#putTableInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
tableName	String	The table name
requestMessage	Object	The request message

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

refreshDataset

Object refreshDataset(datasetKey)

Start a dataset refresh

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Object result = apiInstance.refreshDataset(datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#refreshDataset");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

refreshDatasetInGroup

Object refreshDatasetInGroup(groupId, datasetKey)

Start a dataset refresh

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Object result = apiInstance.refreshDatasetInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#refreshDatasetInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

setAllDatasetConnections

Object setAllDatasetConnections(datasetKey, parameters)

Sets all connections for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String datasetKey = "datasetKey_example"; // String | The dataset id
ConnectionDetails parameters = new ConnectionDetails(); // ConnectionDetails | The body
try {
    Object result = apiInstance.setAllDatasetConnections(datasetKey, parameters);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#setAllDatasetConnections");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
datasetKey	String	The dataset id
parameters	ConnectionDetails	The body

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

setAllDatasetConnectionsInGroup

Object setAllDatasetConnectionsInGroup(groupId, datasetKey, parameters)

Sets all connections for the specified dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
ConnectionDetails parameters = new ConnectionDetails(); // ConnectionDetails | The body
try {
    Object result = apiInstance.setAllDatasetConnectionsInGroup(groupId, datasetKey, parameters);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#setAllDatasetConnectionsInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description
groupId	String	The group id
datasetKey	String	The dataset id
parameters	ConnectionDetails	The body

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

takeOverInGroup

Object takeOverInGroup(groupId, datasetKey)

Take Over a dataset

Example

// Import classes:
//import com.microsoft.powerbi.ApiException;
//import com.microsoft.powerbi.api.DatasetsApi;


DatasetsApi apiInstance = new DatasetsApi();
String groupId = "groupId_example"; // String | The group id
String datasetKey = "datasetKey_example"; // String | The dataset id
try {
    Object result = apiInstance.takeOverInGroup(groupId, datasetKey);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling DatasetsApi#takeOverInGroup");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
groupId	String	The group id
datasetKey	String	The dataset id

Return type

Object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

FilesExpand file tree

DatasetsApi.md

Latest commit

History

DatasetsApi.md

File metadata and controls

DatasetsApi

bindToGateway

Example

Parameters

Return type

Authorization

HTTP request headers

bindToGatewayInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDatasetById

Example

Parameters

Return type

Authorization

HTTP request headers

deleteDatasetByIdInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRows

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRowsInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

generateTokenInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasetById

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasetByIdInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasets

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasetsInGroup

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasources

Example

Parameters

Return type

Authorization

HTTP request headers

getDatasourcesInGroup