Help Desk

Submit a ticket My Tickets
Welcome
Login

Power BI Command Reference

This BizApp enables connectivity to Power BI including exporting/importing data and managing the various objects that make up your Power BI deployment.

Connections

Power BI

OAuth connection for your Azure AD application.

Inputs

Input Type Detail Notes
Tenant ID TextField The Azure AD tenant id (e.g. aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee)
Application (Client) ID TextField The Application ID of the registered application in Azure AD for Power BI
Username TextField The username of the Power BI user you would like to authenticate with.
Password TextField The password of the Power BI user you would like to authenticate with.
Base URI TextField The Base URI of the Power BI instance. (Default is https://api.powerbi.com)

Commands

Add Rows to Dataset

Adds new data rows to the specified table, within the specified dataset, from the specified workspace. NOTE: Duplicate rows will be ignored inside of Power BI, but still considered added in this command.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id
Table Name TextField The table name
Data FileField The file containing the data set to be pushed into the table.
Data Type DropdownField The type of data you are pushing into the table. Can be either JSON or CSV.
Delimiter TextField If the data is of CSV data type, be sure to enter the data delimiter here.

Outputs

Output Output Type Notes
Rows Added Integer

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Bind Dataset to Gateway

Binds the specified dataset from the specified workspace to the specified gateway. Only supported for the On-Premises Data Gateway.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id
Gateway ID TextField The gateway id

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Clone Report

Clones the specified report from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id
Name TextField The name of the new report created
Target Dataset ID TextField Optional parameter for specifying the target associated dataset id. If not provided, the new report will be associated with the same dataset as the source report.
Target Workspace ID TextField Optional parameter for specifying the target workspace id. Empty Guid (00000000-0000-0000-0000-000000000000) indicates 'My Workspace'. If not provided, the new report will be cloned within the same workspace as the source report.

Outputs

Output Output Type Notes
Report Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Create Dataset

Creates a new dataset in the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of. the workspace.
Name TextField The name of the dataset
Tables GroupField The tables in the dataset.

Outputs

Output Output Type Notes
Dataset Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Create Temporary Upload Location

Creates a temporary blob storage to be used to import large .pbix files larger than 1 GB and up to 10 GB. To import large .pbix files, create a temporary upload location and upload the .pbix file using the shared access signature (SAS) url from the response, and then call Post Import In Group and specify 'fileUrl' to be the SAS url in the Request Body. Note: Import large .pbix files is only available for workspaces on premium capacity and for .pbix files that is between 1 GB and 10 GB.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id

Outputs

Output Output Type Notes
URL String
Expires At Date

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Delete All Rows in Table

Deletes all rows from the specified table, within the specified dataset, from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id
Table Name TextField The table name

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Delete Dataset

Deletes the specified dataset from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id

Outputs

Output Output Type Notes
Dataset ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Delete Report

Deletes the specified report from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id

Outputs

Output Output Type Notes
Deleted Report ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Export Report

Exports the specified report from the specified workspace to a .pbix file.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id

Outputs

Output Output Type Notes
Report Export (.pbix) File

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Get Dataset

Returns the specified dataset from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id

Outputs

Output Output Type Notes
Dataset Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Get Dataset Datasources

Returns a list of datasources for the specified dataset from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id

Outputs

Output Output Type Notes
Datasources Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Get Dataset Tables

Returns a list of tables within the specified dataset from the specified workspace. Note: This command supports only Push datasets.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id

Outputs

Output Output Type Notes
Tables Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Get Report

Returns the specified report from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id

Outputs

Output Output Type Notes
Report Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Import File

Creates new content on the specified workspace from .pbix, .json, Excel, or file path in OneDrive for Business.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset Name TextField The display name of the dataset should include file extension. Not supported when importing from OneDrive for Business.
On Name Conflict DropdownField Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'
.pbix File FileField If importing a .pbix file, the file to import. Must be smaller than 1GB.
Import Info GroupField The import details of the file you are importing. This is only required if importing from OneDrive for Business or large .pbix files.
Run Asynchronously BooleanField If this is checked, the command will not wait for the import to finish.

Outputs

Output Output Type Notes
Import Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

List Dashboards

List the dashboards that exist in a workspace and that this user has access to.

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of. the workspace.

Outputs

Output Output Type Notes
Dashboards Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

List Datasets

List the datasets that exist in a workspace and that this user has access to.

Inputs

Input Type Detail Notes
Workspace ID TextField The ID of. the workspace.

Outputs

Output Output Type Notes
Datasets Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

List Gateway Datasources

Returns a list of datasources from the specified gateway.

Inputs

Input Type Detail Notes
Gateway ID TextField The gateway id

Outputs

Output Output Type Notes
Datasources Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

List Gateways

Returns a list of gateways for which the user is an admin.

Inputs

None

Outputs

Output Output Type Notes
Gateways Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

List Reports

Returns a list of reports from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id

Outputs

Output Output Type Notes
Reports Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Rebind Report to Dataset

Rebinds the specified report from the specified workspace to the requested dataset.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id
Dataset ID TextField The new dataset of the rebinded report

Outputs

Output Output Type Notes
Report ID String

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Refresh Dataset

Triggers a refresh for the specified dataset from the specified workspace.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Dataset ID TextField The dataset id
Notification Type DropdownField The notification type to send when the refresh completes.

Outputs

None

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI

Update Report Content

Updates the specified report from the specified workspace to have the same content as the specified report in the request body.

Inputs

Input Type Detail Notes
Workspace ID TextField The workspace id
Report ID TextField The report id
Source Report ID TextField The ID of the source report
Source Workspace ID TextField The id of the workspace the the source report is in

Outputs

Output Output Type Notes
Report Json

Exit Codes

Code Type Detail
0 Success Success
1 Error There was an error during execution
2 Error There was an error authenticating with Power BI
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.