Microsoft Power BI Connector Reference
Anypoint Connector for Microsoft Power BI (Power BI Connector) gives you access to the Microsoft Power BI APIs. This connector exposes the most commonly used operations provided by the Microsoft Power BI APIs.
Configurations
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Response Timeout |
Number |
Timeout for the request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Oauth2 Authorization Code Connection Provider
Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to Configuring OAuth 2.0 for Connectors or Configuring OAuth 2.0 for Connectors on CloudHub.
Used in apps that are installed on a device to gain access to protected resources.
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
Space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own base URI. |
|
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Consumer Key |
String |
OAuth consumerKey as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumerSecret as registered with the service provider. |
x |
|
Authorization Url |
String |
Service provider’s authorization endpoint URL. |
|
|
Access Token Url |
String |
Service provider’s access token endpoint URL. |
|
|
Scopes |
String |
OAuth scopes to request during the OAuth dance. If a value is not provided, it defaults to the OAuth scopes in the annotation. |
||
Resource Owner Id |
String |
Resource Owner ID that each component should use if a Resource Owner ID is not otherwise referenced. |
||
Before |
String |
Name of a flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of a flow to execute immediately after an access token is received. |
||
Listener Config |
String |
A reference to a <http:listener-config /> to use to create the listener that will receive the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to specify the OAuth provider the URL should use to access the callback. |
||
Object Store |
String |
Reference to the object store to use to store each resource owner ID’s data. If not specified, Mule automatically provisions the default object store. |
Capacities AssignWorkspacesToCapacity
<power-bi-rest:create-admin-capacities-assign-workspaces>
Assigns the provided workspaces to the specified capacity. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
or Tenant.ReadWrite.All
This operation makes an HTTP POST request to the /admin/capacities/AssignWorkspaces endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Capacities UnassignWorkspacesFromCapacity
<power-bi-rest:create-admin-capacities-unassign-workspaces>
Capacities UnassignWorkspacesFromCapacity Unassigns the provided workspaces from capacity. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. Required scope: Tenant.Read.All or Tenant.ReadWrite.All This operation makes an HTTP POST request to the /admin/capacities/UnassignWorkspaces endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups RestoreDeletedGroupAsAdmin
<power-bi-rest:create-admin-groups-restore-by-group-id>
Groups RestoreDeletedGroupAsAdmin Restores a deleted workspace. Note: This API is currently limited to restoring workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum. This API allows 200 requests per hour at maximum. Required scope: Tenant.ReadWrite.All This operation makes an HTTP POST request to the /admin/groups/{groupId}/restore endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups AddUserAsAdmin
<power-bi-rest:create-admin-groups-users-by-group-id>
Grants user permissions to the specified workspace. Note: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
This operation makes an HTTP POST request to the /admin/groups/{groupId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Add Power BI Encryption Key
<power-bi-rest:create-admin-tenant-keys>
Adds an encryption key for Power BI workspaces assigned to a capacity. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP POST request to the /admin/tenantKeys endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Rotate Power BI Encryption Key
<power-bi-rest:create-admin-tenant-keys-default-rotate-by-tenant-key-id>
Rotates the encryption key for Power BI workspaces assigned to a capacity. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP POST request to the /admin/tenantKeys/{tenantKeyId}/Default.Rotate endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Tenant Key Id |
String |
Tenant Key Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups AssignMyWorkspaceToCapacity
<power-bi-rest:create-assign-to-capacity>
Assigns "My Workspace" to the specified capacity. Note: To perform this operation, the user must have admin or assign permissions on the capacity. To unassign "My Workspace" from a capacity, an Empty Guid (00000000-0000-0000-0000-000000000000) should be provided as the capacityId.
Required scopes: Capacity.ReadWrite.All and Workspace.ReadWrite.All
This operation makes an HTTP POST request to the /AssignToCapacity endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Add Dashboard
<power-bi-rest:create-dashboards>
Creates a new empty dashboard on "My Workspace".
Required scope: Content.Create
This operation makes an HTTP POST request to the /dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Clone Tile
<power-bi-rest:create-dashboards-tiles-clone-by-dashboard-id-tile-id>
Clones the specified tile from "My Workspace". If the target report ID and target dataset are not specified, the following can occur:
-
When a tile clone is performed within the same workspace, the report and dataset links will be cloned from the source tile.
-
When cloning a tile within a different workspace, the report and dataset links will be rested, and the tile will be broken.
Required scope: Dashboard.ReadWrite.All
This operation makes an HTTP POST request to the /dashboards/{dashboardId}/tiles/{tileId}/Clone endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets PostDataset
<power-bi-rest:create-datasets>
Creates a new dataset on "My Workspace". Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Bind To Gateway
<power-bi-rest:create-datasets-default-bind-to-gateway-by-dataset-id>
Binds the specified dataset from "My Workspace" to the specified gateway with an optional given set of datasource IDs. This only supports the On-Premises Data Gateway.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /datasets/{datasetId}/Default.BindToGateway endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Set All Dataset Connections
<power-bi-rest:create-datasets-default-set-all-connections-by-dataset-id>
Note: This API is deprecated and no longer supported. Updates all connections for the specified dataset from "My Workspace".
Notes:
To update connection details for SQL, AS, OData Feed, and SharePoint, use Update Datasources. For other datasource types, use Update Parameters.This API only supports SQL DirectQuery datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /datasets/{datasetId}/Default.SetAllConnections endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Datasources
<power-bi-rest:create-datasets-default-update-datasources-by-dataset-id>
Updates the datasources of the specified dataset from "My Workspace". Important: The original datasource and the new datasource must have the exact same schema. For cached models, the dataset must be refreshed to get the data from the new data sources. Wait 30 minutes for the Update Datasources operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
Restrictions
-
Update Datasources supports the following datasource types:
-
SQL Server
-
Azure SQL Server
-
Analysis Services
-
Azure Analysis Services
-
OData Feed
-
SharePoint
-
Oracle
-
Teradata
-
SapHana
For other datasource types, use Update Parameters
-
-
Changing datasource type is not supported.
-
Datasources that contain parameters on the connection string are not supported.
-
Datasources that are part of Merged or Joined tables are not supported.
This operation makes an HTTP POST request to the /datasets/{datasetId}/Default.UpdateDatasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Parameters
<power-bi-rest:create-datasets-default-update-parameters-by-dataset-id>
Updates the parameters' values for the specified dataset from "My Workspace". Important: The dataset must be refreshed for new parameters values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
Restrictions
-
All parameters must exist in the dataset.
-
Names are case-sensitive.
-
Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.
-
Datasets with Analysis Services Live connections are not supported.
-
Maximum of 100 parameters per request is allowed.
-
Values must be of the expected Type.
-
Cannot pass empty value to an IsRequired parameter.
-
List cannot be empty or include multiple occurrences of same parameter.
-
Parameters of types 'Any' or 'Binary' cannot be set.
This operation makes an HTTP POST request to the /datasets/{datasetId}/Default.UpdateParameters endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Refresh Dataset
<power-bi-rest:create-datasets-refreshes-by-dataset-id>
Triggers a refresh for the specified dataset from "My Workspace". In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh). In Premium capacities, this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh fails.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /datasets/{datasetId}/refreshes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets PostRows
<power-bi-rest:create-datasets-tables-rows-by-dataset-id-table-name>
Adds new data rows to the specified table within the specified dataset from "My Workspace". Note: This API supports only Push datasets.
REST API Limitations: See Power BI REST API limitations.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /datasets/{datasetId}/tables/{tableName}/rows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Create Datasource
<power-bi-rest:create-gateways-datasources-by-gateway-id>
Creates a new datasource on the specified gateway.
Required scope: Dataset.ReadWrite.AllTo
This operation makes an HTTP POST request to the /gateways/{gatewayId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Add Datasource User
<power-bi-rest:create-gateways-datasources-users-by-gateway-id-datasource-id>
User grants or updates the permissions required to use the specified datasource for the specified user.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /gateways/{gatewayId}/datasources/{datasourceId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Generate Token
<power-bi-rest:create-generate-token>
Generates an embed token for multiple reports, datasets, and target workspaces. Reports and datasets do not have to be related. The binding of a report to a dataset can be done during embedding. Target workspaces are workspaces where creation of reports is allowed. This API is relevant only to 'App owns data' embed scenario.
Required scopes:
-
Content.Create (required only if a target workspace is specified in GenerateTokenRequestV2Report)
-
ReadWrite.All ro Report.Read.All (required only if a report is specified in GenerateTokenRequestV2
-
Report.ReadWrite.All (required if allowEdit flag is specified for at least one report in GenerateTokenRequestV2)
-
Dataset.ReadWrite.All or Dataset.Read.All
Restrictions
-
All the reports and datasets must reside in workspace V2.
-
All the target workpaces must be workspace V2.Maximum number of reports, datasets and target workspaces is 50 each.
-
Generating Embed Token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.
This operation makes an HTTP POST request to the /GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Create Group
<power-bi-rest:create-groups>
Create Group Creates new workspace.
Required scope: Workspace.ReadWrite.All
This operation makes an HTTP POST request to the /groups endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups AssignToCapacity
<power-bi-rest:create-groups-assign-to-capacity-by-group-id>
Assigns the specified workspace to the specified capacity. Note: To perform this operation, the user must be an admin on the specified workspace and have admin or assign permissions on the capacity. To unassign the specified workspace from a capacity, an empty GUID(00000000-0000-0000-0000-000000000000) should be provided as the capacityId.
Required scope: Capacity.ReadWrite.All and Workspace.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/AssignToCapacity endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups AssignToDataflowStorage
<power-bi-rest:create-groups-assign-to-dataflow-storage-by-group-id>
Assigns the specified workspace to the specified dataflow storage account. Note: To perform this operation, the user must be an admin on the specified workspace and the Power BI dataflow storage account must be enabled. To unassign the specified workspace from a Power BI dataflow storage account, an empty GUID (00000000-0000-0000-0000-000000000000) must be provided as the dataflowStorageId
.
Required scope: StorageAccount.ReadWrite.All and Workspace.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/AssignToDataflowStorage endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Add Dashboard In Group
<power-bi-rest:create-groups-dashboards-by-group-id>
Creates a new empty dashboard on the specified workspace.
Required scope: Content.Create
This operation makes an HTTP POST request to the /groups/{groupId}/dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dashboards GenerateTokenInGroup
<power-bi-rest:create-groups-dashboards-generate-token-by-group-id-dashboard-id>
Generates an embed token to view the specified dashboard from the specified workspace. This API is relevant only to the 'App owns data' embed scenario.
Required scopes:
-
Dashboard.ReadWrite.All or Dashboard.Read.All
-
Report.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.AllTo set the permissions scope
This operation makes an HTTP POST request to the /groups/{groupId}/dashboards/{dashboardId}/GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Clone Tile In Group
<power-bi-rest:create-groups-dashboards-tiles-clone-by-group-id-dashboard-id-tile-id>
Clones the specified tile from the specified workspace. If target report ID and target dataset are missing, the following can occur:
-
When a tile clone is performed within the same workspace, the report and dataset links will be cloned from the source tile.
-
If you are cloning a tile within a different workspace, report and dataset links will be rested. * The tile will be broken.
Required scope: Dashboard.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/dashboards/{dashboardId}/tiles/{tileId}/Clone endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Tiles GenerateTokenInGroup
<power-bi-rest:create-groups-dashboards-tiles-generate-token-by-group-id-dashboard-id-tile-id>
Generates an embed token to view the specified tile from the specified workspace. This API is relevant only to 'App owns data' embed scenario.
Required scopes:
-
Dashboard.ReadWrite.All or Dashboard.Read.All
-
Report.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, refer to Service Principal with Power BI document along with considerations and limitations section.
This operation makes an HTTP POST request to the /groups/{groupId}/dashboards/{dashboardId}/tiles/{tileId}/GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Refresh Dataflow
<power-bi-rest:create-groups-dataflows-refreshes-by-group-id-dataflow-id>
Triggers a refresh for the specified dataflow.
Required scope: Dataflow.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/dataflows/{dataflowId}/refreshes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets PostDatasetInGroup
<power-bi-rest:create-groups-datasets-by-group-id>
Creates a new dataset in the specified workspace. Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Bind To Gateway In Group
<power-bi-rest:create-groups-datasets-default-bind-to-gateway-by-group-id-dataset-id>
Binds the specified dataset from the specified workspace to the specified gateway with (optional) given set of datasource IDs. This only supports the On-Premises Data Gateway.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/Default.BindToGateway endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Set All Dataset Connections In Group
<power-bi-rest:create-groups-datasets-default-set-all-connections-by-group-id-dataset-id>
This API is deprecated and no longer supported. Updates all connections for the specified dataset from the specified workspace. Notes:To update connection details for SQL, AS, OData Feed, and SharePoint, use Update Datasources In Group. For other datasource types, use Update Parameters In Group. This API only supports SQL DirectQuery datasets. |
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/Default.SetAllConnections endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Take Over In Group
<power-bi-rest:create-groups-datasets-default-take-over-by-group-id-dataset-id>
Transfers ownership over the specified dataset to the current authorized user.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/Default.TakeOver endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Datasources In Group
<power-bi-rest:create-groups-datasets-default-update-datasources-by-group-id-dataset-id>
Updates the datasources of the specified dataset from the specified workspace.
Important:
-
The original datasource and the new datasource must have the exact same schema.
-
For cached models, the dataset must be refreshed to get the data from the new datasources. Wait 30 minutes for the update datasources operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
Restrictions
-
Update datasources supports the following datasource types: SQL Server, Azure SQL Server, Analysis Services, Azure Analysis Services, OData Feed, SharePoint, Oracle, Teradata, SapHana. For other datasource types, use Update Parameters In Group.
-
Changing the datasource type is not supported.
-
Datasources that contain parameters on the connection string are not supported.
-
Datasources that are part of Merged or Joined tables are not supported.
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/Default.UpdateDatasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Parameters In Group
<power-bi-rest:create-groups-datasets-default-update-parameters-by-group-id-dataset-id>
Updates the parameters values for the specified dataset from the specified workspace. Important: The dataset must be refreshed for the new parameter values to be applied. Wait 30 minutes for the update parameters operation to complete before refreshing.
Required scope: Dataset.ReadWrite.All
Restrictions
-
All parameters must exist in the dataset.
-
Names are case-sensitive.
-
Datasets with SQL, Oracle, Teradata & SapHana Direct Query connections are not supported.
-
Datasets with Analysis Services Live connections are not supported.
-
A maximum of 100 parameters per request is allowed.
-
Values must be of the expected type.
-
An empty value is not permitted for the
IsRequired
parameter. -
A List cannot be empty or include multiple occurrences of the same parameter.
-
Parameters of the types 'Any' or 'Binary' cannot be set.
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/Default.UpdateParameters endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GenerateTokenInGroup
<power-bi-rest:create-groups-datasets-generate-token-by-group-id-dataset-id>
Generates an embed token to Embed Q&A based on the specified dataset from the specified workspace. This API is relevant only to 'App owns data' embed scenario.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Refresh Dataset In Group
<power-bi-rest:create-groups-datasets-refreshes-by-group-id-dataset-id>
Triggers a refresh for the specified dataset from the specified workspace. In Shared capacities this call is limited to eight times per day (including refreshes executed via Scheduled Refresh). In Premium capacities this call is not limited in number of times per day, but only by the available resources in the capacity, hence if overloaded, the refresh execution may be throttled until the load is reduced. If this throttling exceeds 1 hour, the refresh fails.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/refreshes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets PostRowsInGroup
<power-bi-rest:create-groups-datasets-tables-rows-by-group-id-dataset-id-table-name>
Adds new data rows to the specified table, within the specified dataset, from the specified workspace.
Note: This API supports only Push datasets.
REST API Limitations: See Power BI REST API limitations.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/datasets/{datasetId}/tables/{tableName}/rows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Post Import In Group
<power-bi-rest:create-groups-imports-by-group-id>
Creates new content on the specified workspace from .pbix, .json, Excel, Rdl, or file path in OneDrive for Business.
Required scope: Dataset.ReadWrite.All
Notes:
-
To import a file, request Headers should include Content-Type: multipart/form-data with the file encoded as form data in the request body.
-
To import from OneDrive for Business, request Headers should include Content-Type: application/json with ImportInfo in the request body.
-
To import large .pbix files between 1 GB and 10 GB see Create Temporary Upload Location In Group, supported only for workspaces on premium capacity.
-
To create a dataflow from a model.json, specify the parameter Dataset Display Name as described below.
This operation makes an HTTP POST request to the /groups/{groupId}/imports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Display Name |
String |
The display name of the dataset must include the file extension. Not supported when importing from OneDrive for Business. For importing or creating dataflows, this parameter must be hardcoded to model.json. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Create Temporary Upload Location In Group
<power-bi-rest:create-groups-imports-create-temporary-upload-location-by-group-id>
Creates a temporary blob storage to use 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 the value for 'fileUrl' as the SAS URL in the Request Body.
Note: Importing of large .pbix files is only available for workspaces on premium capacity and for .pbix files that are between 1 GB and 10 GB.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/imports/createTemporaryUploadLocation endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Clone Report In Group
<power-bi-rest:create-groups-reports-clone-by-group-id-report-id>
Clones the specified report from the specified workspace. If after cloning the report and its dataset reside in two different upgraded workspaces or "My Workspace", a shared dataset will be created in the report’s workspace. Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
Required permissions:
-
Report - Write permissions.
-
Target dataset (if provided)
-
Build permissions
This operation makes an HTTP POST request to the /groups/{groupId}/reports/{reportId}/Clone endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Export To File In Group
<power-bi-rest:create-groups-reports-export-to-by-group-id-report-id>
Exports the specified report from the specified workspace to the requested format.
Required scopes:
-
Report.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP POST request to the /groups/{groupId}/reports/{reportId}/ExportTo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Reports GenerateTokenForCreateInGroup
<power-bi-rest:create-groups-reports-generate-token-by-group-id>
Generates an embed token to allow report creation on the specified workspace based on the specified dataset. This API is relevant only to 'App owns data' embed scenario.
Required scopes:
-
Content.CreateReport.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.All
Restrictions
Generating an embed token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.
This operation makes an HTTP POST request to the /groups/{groupId}/reports/GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Reports GenerateTokenInGroup
<power-bi-rest:create-groups-reports-generate-token-by-group-id-report-id>
Generates an embed token to view or edit the specified report from the specified workspace. This API is relevant only to the 'App owns data' embed scenario.
Required scopes:
-
Report.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.All
-
Content.Create - required only if allowSaveAs specified in GenerateTokenRequest
Restrictions
Generating an embed token with RLS may not work for AS Azure or AS OnPrem live connection reports for several minutes after a Rebind.
This operation makes an HTTP POST request to the /groups/{groupId}/reports/{reportId}/GenerateToken endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Rebind Report In Group
<power-bi-rest:create-groups-reports-rebind-by-group-id-report-id>
Rebinds the specified report from the specified workspace to the requested dataset. If the dataset resides in a different upgraded workspace or in "My Workspace", a shared dataset will be created in the report’s workspace. Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
Required permissions: Report - Write permissions. Target dataset - Build permissions
This operation makes an HTTP POST request to the /groups/{groupId}/reports/{reportId}/Rebind endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Report Content In Group
<power-bi-rest:create-groups-reports-update-report-content-by-group-id-report-id>
Updates the specified report from the specified workspace to have the same content as the specified report in the request body.
Required scope: Report.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/reports/{reportId}/UpdateReportContent endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Add Group User
<power-bi-rest:create-groups-users-by-group-id>
Grants the specified user permissions to the specified workspace.
Notes: Users that have been recently added to a group may not have their new group immediately available, see Refresh user permissions.
Required scope: Workspace.ReadWrite.All
This operation makes an HTTP POST request to the /groups/{groupId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Post Import
<power-bi-rest:create-imports>
Creates new content on "My Workspace" from .pbix, Excel, Rdl or file path in OneDrive for Business.
Required scope: Dataset.ReadWrite.All
Notes:
-
To import a file, request Headers should include Content-Type: multipart/form-data with the file encoded as form data in the request body.
-
To import xlsx file from OneDrive for Business, request Headers should include Content-Type: application/json with ImportInfo in the request body.Import .pbix file from OneDrive is not supported.
-
To import large .pbix files between 1 GB and 10 GB, see the Power BI documentation: Create Temporary Upload Location, supported only for workspaces on premium capacity.
This operation makes an HTTP POST request to the /imports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Display Name |
String |
string The display name of the dataset, should include file extension. Not supported when importing from OneDrive for Business. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Create Temporary Upload Location
<power-bi-rest:create-imports-create-temporary-upload-location>
Creates a temporary blob storage to use 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 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 are between 1 GB and 10 GB.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP POST request to the /imports/createTemporaryUploadLocation endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Refresh User Permissions
<power-bi-rest:create-refresh-user-permissions>
Refreshes user permissions in Power BI. When a user is granted permissions to a workspace, app, or artifact, it might not be immediately available through API calls. This operation refreshes user permissions and ensures that the user permissions are fully updated.
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
Restrictions
This API can be called only once per hour.
This operation makes an HTTP POST request to the /RefreshUserPermissions endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Clone Report
<power-bi-rest:create-reports-clone-by-report-id>
Clones the specified report from "My Workspace". If after cloning, the report and its dataset reside in two different upgraded workspaces or "My Workspace", a shared dataset will be created in the report’s workspace. Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions.
This operation makes an HTTP POST request to the /reports/{reportId}/Clone endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Export To File
<power-bi-rest:create-reports-export-to-by-report-id>
Exports the specified report from "My Workspace" to the requested format.
Required scopes:
-
Report.ReadWrite.All or Report.Read.All
-
Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP POST request to the /reports/{reportId}/ExportTo endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Rebind Report
<power-bi-rest:create-reports-rebind-by-report-id>
Rebinds the specified report from "My Workspace" to the requested dataset. If the dataset resides in a different upgraded workspace, a shared dataset will be created in "My Workspace". Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
Required permissions: Report - Write permissions. Target dataset - Build permissions.
This operation makes an HTTP POST request to the /reports/{reportId}/Rebind endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Report Content
<power-bi-rest:create-reports-update-report-content-by-report-id>
Updates the specified report from "My Workspace" to have the same content as the report in the request body.
Required scope: Report.ReadWrite.All
This operation makes an HTTP POST request to the /reports/{reportId}/UpdateReportContent endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups DeleteUserAsAdmin
<power-bi-rest:delete-admin-groups-users-by-group-id-user>
Removes user permissions to the specified workspace. Note: This API is currently limited to updating workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
This operation makes an HTTP DELETE request to the /admin/groups/{groupId}/users/{user} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
user |
String |
user |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Dataset
<power-bi-rest:delete-datasets-by-dataset-id>
Deletes the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP DELETE request to the /datasets/{datasetId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets DeleteRows
<power-bi-rest:delete-datasets-tables-rows-by-dataset-id-table-name>
Deletes all rows from the specified table within the specified dataset from "My Workspace". Note: this API supports only Push datasets.
Required scope: Dataset.ReadWrite.
All This operation makes an HTTP DELETE request to the /datasets/{datasetId}/tables/{tableName}/rows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Datasource
<power-bi-rest:delete-gateways-datasources-by-gateway-id-datasource-id>
Deletes the specified datasource from the specified gateway.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP DELETE request to the /gateways/{gatewayId}/datasources/{datasourceId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Datasource User
<power-bi-rest:delete-gateways-datasources-users-by-gateway-id-datasource-id-email-address>
Removes the specified user from the specified datasource.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP DELETE request to the /gateways/{gatewayId}/datasources/{datasourceId}/users/{emailAddress} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Email Address |
String |
Email Address |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Group
<power-bi-rest:delete-groups-by-group-id>
Deletes the specified workspace.
Required scope: Workspace.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Dataflow
<power-bi-rest:delete-groups-dataflows-by-group-id-dataflow-id>
Deletes a dataflow from the CDS for Analytics storage, including its definition file and actual model.
Required scope: Dataflow.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId}/dataflows/{dataflowId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Dataset In Group
<power-bi-rest:delete-groups-datasets-by-group-id-dataset-id>
Deletes the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId}/datasets/{datasetId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets DeleteRowsInGroup
<power-bi-rest:delete-groups-datasets-tables-rows-by-group-id-dataset-id-table-name>
Deletes all rows from the specified table, within the specified dataset, from the specified workspace. Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId}/datasets/{datasetId}/tables/{tableName}/rows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Report In Group
<power-bi-rest:delete-groups-reports-by-group-id-report-id>
Delete Report In Group Deletes the specified report from the specified workspace.
Required scope: Report.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId}/reports/{reportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete User In Group
<power-bi-rest:delete-groups-users-by-group-id-user>
Deletes the specified user permissions from the specified workspace.
Required scope: Workspace.ReadWrite.All
This operation makes an HTTP DELETE request to the /groups/{groupId}/users/{user} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
user |
String |
user |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Delete Report
<power-bi-rest:delete-reports-by-report-id>
Deletes the specified report from "My Workspace".
Required scope: Report.ReadWrite.All
This operation makes an HTTP DELETE request to the /reports/{reportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Activity Events
<power-bi-rest:get-admin-activityevents>
Returns a list of audit activity events for a tenant. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All.
To call this API, provide either a continuation token or both a start and end date time. StartDateTime and EndDateTime must be in the same UTC day.
This operation makes an HTTP GET request to the /admin/activityevents endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Capacities As Admin
<power-bi-rest:get-admin-capacities>
Returns a list of capacities for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/capacities endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshables
<power-bi-rest:get-admin-capacities-refreshables>
Returns a list of refreshables for the organization within a capacity Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/capacities/refreshables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
$top |
String |
integer int32 Returns only the first n results. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshables For Capacity As Admin
<power-bi-rest:get-admin-capacities-refreshables-by-capacity-id>
Returns a list of refreshables for the specified capacity the user has access to Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/capacities/{capacityId}/refreshables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
$top |
String |
integer int32 Returns only the first n results. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshable For Capacity
<power-bi-rest:get-admin-capacities-refreshables-by-capacity-id-refreshable-id>
Returns the specified refreshable for the specified capacity the user has access to Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/capacities/{capacityId}/refreshables/{refreshableId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Refreshable Id |
String |
Refreshable Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dashboards GetDashboardsAsAdmin
<power-bi-rest:get-admin-dashboards>
Returns a list of dashboards for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dashboards GetTilesAsAdmin
<power-bi-rest:get-admin-dashboards-tiles-by-dashboard-id>
Returns a list of tiles within the specified dashboard. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/dashboards/{dashboardId}/tiles endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dataflows GetDataflowsAsAdmin
<power-bi-rest:get-admin-dataflows>
Returns a list of dataflows for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/dataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dataflows GetDataflowDatasourcesAsAdmin
<power-bi-rest:get-admin-dataflows-datasources-by-dataflow-id>
Returns a list of datasources for the specified dataflow. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
This operation makes an HTTP GET request to the /admin/dataflows/{dataflowId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dataflows ExportDataflowAsAdmin
<power-bi-rest:get-admin-dataflows-export-by-dataflow-id>
Exports the specified dataflow definition to a JSON file. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
This operation makes an HTTP GET request to the /admin/dataflows/{dataflowId}/export endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetDatasetsAsAdmin
<power-bi-rest:get-admin-datasets>
Returns a list of datasets for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API processes each request for 2 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetDatasourcesAsAdmin
<power-bi-rest:get-admin-datasets-datasources-by-dataset-id>
Returns a list of datasources for the specified dataset. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API processes each request for 0.5 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
This operation makes an HTTP GET request to the /admin/datasets/{datasetId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups GetGroupsAsAdmin
<power-bi-rest:get-admin-groups>
Returns a list of workspaces for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
$top |
String |
integer int32 Returns only the first n results. This parameter is mandatory and must be in the range of 1-5000. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dashboards GetDashboardsInGroupAsAdmin
<power-bi-rest:get-admin-groups-dashboards-by-group-id>
Returns a list of dashboards from the specified workspace. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dataflows GetDataflowsInGroupAsAdmin
<power-bi-rest:get-admin-groups-dataflows-by-group-id>
Returns a list of dataflows from the specified workspace. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/dataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Dataflows GetUpstreamDataflowsInGroupAsAdmin
<power-bi-rest:get-admin-groups-dataflows-upstream-dataflows-by-group-id-dataflow-id>
Returns a list of upstream dataflows for the specified dataflow. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/dataflows/{dataflowId}/upstreamDataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetDatasetsInGroupAsAdmin
<power-bi-rest:get-admin-groups-datasets-by-group-id>
Returns a list of datasets from the specified workspace. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetDatasetToDataflowsLinksInGroupAsAdmin
<power-bi-rest:get-admin-groups-datasets-upstream-dataflows-by-group-id>
Returns a list of upstream dataflows for datasets from the specified workspace. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/datasets/upstreamDataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Reports GetReportsInGroupAsAdmin
<power-bi-rest:get-admin-groups-reports-by-group-id>
Returns a list of reports from the specified workspace. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/groups/{groupId}/reports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Imports GetImportsAsAdmin
<power-bi-rest:get-admin-imports>
Returns a list of imports for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/imports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Reports GetReportsAsAdmin
<power-bi-rest:get-admin-reports>
Returns a list of reports for the organization. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/reports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Power BI Encryption Keys
<power-bi-rest:get-admin-tenant-keys>
Returns the encryption keys for the tenant. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP GET request to the /admin/tenantKeys endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Apps
<power-bi-rest:get-apps>
Get Apps Returns a list of installed apps.
Required scope: App.Read.All
This operation makes an HTTP GET request to the /apps endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get App
<power-bi-rest:get-apps-by-app-id>
Get App Returns the specified installed app.
Required scope: App.Read.All
This operation makes an HTTP GET request to the /apps/{appId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboards From App
<power-bi-rest:get-apps-dashboards-by-app-id>
Returns a list of dashboards from the specified app.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboard From App
<power-bi-rest:get-apps-dashboards-by-app-id-dashboard-id>
Returns the specified dashboard from the specified app.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/dashboards/{dashboardId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tiles From App
<power-bi-rest:get-apps-dashboards-tiles-by-app-id-dashboard-id>
Returns a list of tiles within the specified dashboard from the specified app.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/dashboards/{dashboardId}/tiles endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tile From App
<power-bi-rest:get-apps-dashboards-tiles-by-app-id-dashboard-id-tile-id>
Returns the specified tile within the specified dashboard from the specified app. Note: All tile types are supported except for "model tiles", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/dashboards/{dashboardId}/tiles/{tileId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Reports From App
<power-bi-rest:get-apps-reports-by-app-id>
Returns a list of reports from the specified app.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/reports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Report From App
<power-bi-rest:get-apps-reports-by-app-id-report-id>
Returns the specified report from the specified app.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /apps/{appId}/reports/{reportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
App Id |
String |
App Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Available Features
<power-bi-rest:get-available-features>
Returns a list of available features for the user
Required scope: None
This operation makes an HTTP GET request to the /availableFeatures endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Available Feature By Name
<power-bi-rest:get-available-featuresfeature-name>
Returns the specified available feature for user by name.
Required scope: None
This operation makes an HTTP GET request to the /availableFeatures(featureName='{featureName}') endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Feature Name |
String |
Feature Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Capacities
<power-bi-rest:get-capacities>
Returns a list of capacities the user has access to.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshables For All Capacities
<power-bi-rest:get-capacities-refreshables>
Returns a list of refreshables for all capacities of which the user has access to.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities/refreshables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
$top |
String |
integer int32 Returns only the first n results. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshables For Capacity
<power-bi-rest:get-capacities-refreshables-by-capacity-id>
Returns a list of refreshables for the specified capacity the user has access to.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities/{capacityId}/refreshables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
$top |
String |
integer int32 Returns only the first n results. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refreshable For Capacity
<power-bi-rest:get-capacities-refreshables-by-capacity-id-refreshable-id>
Returns the specified refreshable for the specified capacity the user has access to.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities/{capacityId}/refreshables/{refreshableId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Refreshable Id |
String |
Refreshable Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Workloads
<power-bi-rest:get-capacities-workloads-by-capacity-id>
Returns the current state of the specified capacity workloads, if a workload is enabled also returns the maximum memory percentage that the workload can consume.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities/{capacityId}/Workloads endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Workload
<power-bi-rest:get-capacities-workloads-by-capacity-id-workload-name>
Returns the current state of a workload and if the workload is enabled also returns the maximum memory percentage that the workload can consume.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
This operation makes an HTTP GET request to the /capacities/{capacityId}/Workloads/{workloadName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Workload Name |
String |
Workload Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups CapacityAssignmentStatusMyWorkspace
<power-bi-rest:get-capacity-assignment-status>
Gets the status of "My Workspace" assignment to capacity operation. Note:
Required scope: Workspace.Read.All and Workspace.ReadWrite.All
This operation makes an HTTP GET request to the /CapacityAssignmentStatus endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboards
<power-bi-rest:get-dashboards>
Returns a list of dashboards from "My Workspace".
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboard
<power-bi-rest:get-dashboards-by-dashboard-id>
Get Dashboard Returns the specified dashboard from "My Workspace".
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /dashboards/{dashboardId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tiles
<power-bi-rest:get-dashboards-tiles-by-dashboard-id>
Returns a list of tiles within the specified dashboard from "My Workspace". Note: All tile types are supported except for "model tiles", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /dashboards/{dashboardId}/tiles endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tile
<power-bi-rest:get-dashboards-tiles-by-dashboard-id-tile-id>
Returns the specified tile within the specified dashboard from "My Workspace". Note: All tile types are supported except for "model tiles", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /dashboards/{dashboardId}/tiles/{tileId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataflow Storage Accounts
<power-bi-rest:get-dataflow-storage-accounts>
Returns a list of dataflow storage accounts the user has access to.
Required scope: StorageAccount.Read.All or StorageAccount.ReadWrite.All
This operation makes an HTTP GET request to the /dataflowStorageAccounts endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasets
<power-bi-rest:get-datasets>
Returns a list of datasets from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataset
<power-bi-rest:get-datasets-by-dataset-id>
Returns the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasources
<power-bi-rest:get-datasets-datasources-by-dataset-id>
Returns a list of datasources for the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Discover Gateways
<power-bi-rest:get-datasets-default-discover-gateways-by-dataset-id>
Returns a list of gateways which the specified dataset from "My Workspace" can be bound to. This API is relevant only for datasets that have at least one on-premises connection. For datasets with cloud-only connections, it will return an empty list.
Required scope: Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/Default.DiscoverGateways endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Gateway Datasources
<power-bi-rest:get-datasets-default-get-bound-gateway-datasources-by-dataset-id>
Returns a list of gateway datasources for the specified dataset from "My Workspace". Note: Use the new Dataset - Get Datasources API instead.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/Default.GetBoundGatewayDatasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Direct Query Refresh Schedule
<power-bi-rest:get-datasets-direct-query-refresh-schedule-by-dataset-id>
Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/directQueryRefreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Parameters
<power-bi-rest:get-datasets-parameters-by-dataset-id>
Returns a list of parameters for the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All
Restrictions
-
Datasets with SQL
-
Oracle
-
Teradata &
-
SAP HANA Direct Query connections are not supported.
This operation makes an HTTP GET request to the /datasets/{datasetId}/parameters endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refresh Schedule
<power-bi-rest:get-datasets-refresh-schedule-by-dataset-id>
Returns the refresh schedule of the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/refreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refresh History
<power-bi-rest:get-datasets-refreshes-by-dataset-id>
Returns the refresh history of the specified dataset from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/refreshes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetTables
<power-bi-rest:get-datasets-tables-by-dataset-id>
Returns a list of tables within the specified dataset from "My Workspace". Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /datasets/{datasetId}/tables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Gateways
<power-bi-rest:get-gateways>
Returns a list of gateways for which the user is an admin.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /gateways endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Gateway
<power-bi-rest:get-gateways-by-gateway-id>
Returns the specified gateway.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /gateways/{gatewayId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasources From Gateway
<power-bi-rest:get-gateways-datasources-by-gateway-id>
Returns a list of datasources from the specified gateway.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /gateways/{gatewayId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasource
<power-bi-rest:get-gateways-datasources-by-gateway-id-datasource-id>
Returns the specified datasource from the specified gateway.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /gateways/{gatewayId}/datasources/{datasourceId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasource Status
<power-bi-rest:get-gateways-datasources-status-by-gateway-id-datasource-id>
Checks the connectivity status of the specified datasource from the specified gateway.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP GET request to the /gateways/{gatewayId}/datasources/{datasourceId}/status endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasource Users
<power-bi-rest:get-gateways-datasources-users-by-gateway-id-datasource-id>
Returns a list of users who have access to the specified datasource.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /gateways/{gatewayId}/datasources/{datasourceId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Groups
<power-bi-rest:get-groups>
Returns a list of workspaces the user has access to. Note: Users that have been recently added to a group may not have their new group immediately available, see Refresh user permissions.
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
This operation makes an HTTP GET request to the /groups endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups CapacityAssignmentStatus
<power-bi-rest:get-groups-capacity-assignment-status-by-group-id>
Gets the status of the assignment to capacity operation of the specified workspace. Note: To perform this operation, the user must be admin on the specified workspace.
Required scope: Workspace.Read.All and Workspace.ReadWrite.All
This operation makes an HTTP GET request to the /groups/{groupId}/CapacityAssignmentStatus endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboards In Group
<power-bi-rest:get-groups-dashboards-by-group-id>
Returns a list of dashboards from the specified workspace.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dashboards endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dashboard In Group
<power-bi-rest:get-groups-dashboards-by-group-id-dashboard-id>
Returns the specified dashboard from the specified workspace.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dashboards/{dashboardId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tiles In Group
<power-bi-rest:get-groups-dashboards-tiles-by-group-id-dashboard-id>
Returns a list of tiles within the specified dashboard from the specified workspace. Note: All tile types are supported except for "model tiles", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dashboards/{dashboardId}/tiles endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Tile In Group
<power-bi-rest:get-groups-dashboards-tiles-by-group-id-dashboard-id-tile-id>
Returns the specified tile within the specified dashboard from the specified workspace. Note: All tile types are supported except for "model tiles", which include datasets and live tiles that contain an entire report page.
Required scope: Dashboard.ReadWrite.All or Dashboard.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dashboards/{dashboardId}/tiles/{tileId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dashboard Id |
String |
Dashboard Id |
x |
|
Tile Id |
String |
Tile Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataflows
<power-bi-rest:get-groups-dataflows-by-group-id>
Returns a list of all dataflows from the specified workspace.
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataflow
<power-bi-rest:get-groups-dataflows-by-group-id-dataflow-id>
Exports the specified dataflow definition to a JSON file.
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dataflows/{dataflowId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataflow Data Sources
<power-bi-rest:get-groups-dataflows-datasources-by-group-id-dataflow-id>
Returns a list of datasources for the specified dataflow.
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dataflows/{dataflowId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Upstream Dataflows In Group
<power-bi-rest:get-groups-dataflows-upstream-dataflows-by-group-id-dataflow-id>
Returns a list of upstream dataflows for the specified dataflow.
Required scope: Dataflow.ReadWrite.All or Dataflow.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/dataflows/{dataflowId}/upstreamDataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasets In Group
<power-bi-rest:get-groups-datasets-by-group-id>
Returns a list of datasets from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataset In Group
<power-bi-rest:get-groups-datasets-by-group-id-dataset-id>
Returns the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasources In Group From Dataset
<power-bi-rest:get-groups-datasets-datasources-by-group-id-dataset-id>
Returns a list of datasources for the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Discover Gateways In Group
<power-bi-rest:get-groups-datasets-default-discover-gateways-by-group-id-dataset-id>
Returns a list of gateways that the specified dataset from the specified workspace can be bound to. This API is relevant only for datasets that have at least one on-premises connection. For datasets with cloud-only connections, it will return an empty list.
Required scope: Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/Default.DiscoverGateways endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Gateway Datasources In Group
<power-bi-rest:get-groups-datasets-default-get-bound-gateway-datasources-by-group-id-dataset-id>
Returns a list of gateway datasources for the specified dataset from the specified workspace. Note: Use the Dataset - Get Datasources In Group API instead.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/Default.GetBoundGatewayDatasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Direct Query Refresh Schedule In Group
<power-bi-rest:get-groups-datasets-direct-query-refresh-schedule-by-group-id-dataset-id>
Returns the refresh schedule of a specified DirectQuery or LiveConnection dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/directQueryRefreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Parameters In Group
<power-bi-rest:get-groups-datasets-parameters-by-group-id-dataset-id>
Returns a list of parameters for the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All
Restrictions
-
Datasets with SQL
-
Oracle
-
Teradata &
-
SAP HANA Direct Query connections are not supported.
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/parameters endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refresh Schedule In Group
<power-bi-rest:get-groups-datasets-refresh-schedule-by-group-id-dataset-id>
Returns the refresh schedule of the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/refreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Refresh History In Group
<power-bi-rest:get-groups-datasets-refreshes-by-group-id-dataset-id>
Returns the refresh history of the specified dataset from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/refreshes endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets GetTablesInGroup
<power-bi-rest:get-groups-datasets-tables-by-group-id-dataset-id>
Returns a list of tables within the specified dataset from the specified workspace. Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/{datasetId}/tables endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Dataset To Dataflows Links In Group
<power-bi-rest:get-groups-datasets-upstream-dataflows-by-group-id>
Returns a list of upstream dataflows for datasets from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/datasets/upstreamDataflows endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Imports In Group
<power-bi-rest:get-groups-imports-by-group-id>
Returns a list of imports from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
OneDrive .pbix files are not supported.
This operation makes an HTTP GET request to the /groups/{groupId}/imports endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Import In Group
<power-bi-rest:get-groups-imports-by-group-id-import-id>
Returns the specified import from the specified workspace.
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/imports/{importId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Import Id |
String |
Import Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Reports In Group
<power-bi-rest:get-groups-reports-by-group-id>
Returns a list of reports from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Report In Group
<power-bi-rest:get-groups-reports-by-group-id-report-id>
Returns the specified report from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasources In Group From Report
<power-bi-rest:get-groups-reports-datasources-by-group-id-report-id>
Returns a list of datasources for the specified RDL report from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Export Report In Group
<power-bi-rest:get-groups-reports-export-by-group-id-report-id>
Exports the specified report from the specified workspace to a .pbix file.
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/Export endpoint.
Required scope: Report.ReadWrite.All or Report.Read.All
Restrictions
Export of a report with Power BI service live connection after calling Rebind Report is not supported.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Export To File Status In Group
<power-bi-rest:get-groups-reports-exports-by-group-id-report-id-export-id>
Returns the status of the Export to file job from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/exports/{exportId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Export Id |
String |
Export Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get File Of Export To File In Group
<power-bi-rest:get-groups-reports-exports-file-by-group-id-report-id-export-id>
Returns the file of the Export to file job of the specified report from the specified group.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/exports/{exportId}/file endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Export Id |
String |
Export Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Pages In Group
<power-bi-rest:get-groups-reports-pages-by-group-id-report-id>
Returns a list of pages within the specified report from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/pages endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Page In Group
<power-bi-rest:get-groups-reports-pages-by-group-id-report-id-page-name>
Returns the specified page within the specified report from the specified workspace.
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /groups/{groupId}/reports/{reportId}/pages/{pageName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Report Id |
String |
Report Id |
x |
|
Page Name |
String |
Page Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Group Users
<power-bi-rest:get-groups-users-by-group-id>
Returns a list of users that have access to the specified workspace.
Required scope: Workspace.Read.All or Workspace.ReadWrite.All
This operation makes an HTTP GET request to the /groups/{groupId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Imports
<power-bi-rest:get-imports>
Returns a list of imports from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /imports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Import
<power-bi-rest:get-imports-by-import-id>
Returns the specified import from "My Workspace".
Required scope: Dataset.ReadWrite.All or Dataset.Read.All
This operation makes an HTTP GET request to the /imports/{importId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Import Id |
String |
Import Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Reports
<power-bi-rest:get-reports>
Returns a list of reports from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Report
<power-bi-rest:get-reports-by-report-id>
Returns the specified report from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Datasources From Report
<power-bi-rest:get-reports-datasources-by-report-id>
Returns a list of datasources for the specified RDL report from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId}/datasources endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Export Report
<power-bi-rest:get-reports-export-by-report-id>
Exports the specified report from "My Workspace" to a .pbix file.
Required scope: Report.ReadWrite.All or Report.Read.All
Restrictions
Export of a report with Power BI service live connection after calling Rebind Report is not supported.
This operation makes an HTTP GET request to the /reports/{reportId}/Export endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Export To File Status
<power-bi-rest:get-reports-exports-by-report-id-export-id>
Returns the status of the Export to file job from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId}/exports/{exportId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Export Id |
String |
Export Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get File Of Export To File
<power-bi-rest:get-reports-exports-file-by-report-id-export-id>
Returns the file of the Export to file job of the specified report from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId}/exports/{exportId}/file endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Export Id |
String |
Export Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Pages
<power-bi-rest:get-reports-pages-by-report-id>
Returns a list of pages within the specified report from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId}/pages endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Get Page
<power-bi-rest:get-reports-pages-by-report-id-page-name>
Returns the specified page within the specified report from "My Workspace".
Required scope: Report.ReadWrite.All or Report.Read.All
This operation makes an HTTP GET request to the /reports/{reportId}/pages/{pageName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Report Id |
String |
Report Id |
x |
|
Page Name |
String |
Page Name |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Patch Capacity As Admin
<power-bi-rest:patch-admin-capacities-by-capacity-id>
Changes the specific capacity information. Currently, only supports changing the capacity encryption key. Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
This operation makes an HTTP PATCH request to the /admin/capacities/{capacityId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Groups UpdateGroupAsAdmin
<power-bi-rest:patch-admin-groups-by-group-id>
Updates the specified workspace properties. Note: This API is currently limited to updating workspaces in the new workspace experience. Only name and description can be updated, and name must be unique inside an organization. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API. This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
This operation makes an HTTP PATCH request to the /admin/groups/{groupId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Patch Workload
<power-bi-rest:patch-capacities-workloads-by-capacity-id-workload-name>
Changes the state of a specific workload to Enabled or Disabled. When enabling a workload the maximum memory percentage that the workload can consume must be set.
Required scope: Capacity.ReadWrite.All
This operation makes an HTTP PATCH request to the /capacities/{capacityId}/Workloads/{workloadName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Capacity Id |
String |
Capacity Id |
x |
|
Workload Name |
String |
Workload Name |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Direct Query Refresh Schedule
<power-bi-rest:patch-datasets-direct-query-refresh-schedule-by-dataset-id>
Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from "My Workspace". This operation is only supported for the dataset owner. A request must contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both. Setting the frequency automatically truncates the days and times arrays.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PATCH request to the /datasets/{datasetId}/directQueryRefreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Refresh Schedule For Dataset
<power-bi-rest:patch-datasets-refresh-schedule-by-dataset-id>
Updates the refresh schedule for the specified dataset from "My Workspace". This operation is only supported for the dataset owner. A request that disables the refresh schedule should contain no other changes. The days array should not be set to an empty array. The times can be set to empty array (in which case Power BI will use a default single time per day). The limit on the number of time slots per day depends on the type of capacity used (Premium or Shared).
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PATCH request to the /datasets/{datasetId}/refreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Datasource
<power-bi-rest:patch-gateways-datasources-by-gateway-id-datasource-id>
Updates the credentials of the specified datasource from the specified gateway.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PATCH request to the /gateways/{gatewayId}/datasources/{datasourceId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Gateway Id |
String |
Gateway Id |
x |
|
Datasource Id |
String |
Datasource Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Refresh Schedule
<power-bi-rest:patch-groups-dataflows-refresh-schedule-by-group-id-dataflow-id>
Creates or updates the specified dataflow refresh schedule configuration.
Required scope: Dataflow.ReadWrite.All
This operation makes an HTTP PATCH request to the /groups/{groupId}/dataflows/{dataflowId}/refreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataflow Id |
String |
Dataflow Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Direct Query Refresh Schedule In Group
<power-bi-rest:patch-groups-datasets-direct-query-refresh-schedule-by-group-id-dataset-id>
Updates the refresh schedule for the specified DirectQuery or LiveConnection dataset from the specified workspace. This operation is only supported for the dataset owner. A request should contain either a combination of days and times (setting times is optional, otherwise a default single time per day is used) or a valid frequency, but not both. Setting the frequency automatically truncates the days and times arrays.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PATCH request to the /groups/{groupId}/datasets/{datasetId}/directQueryRefreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Refresh Schedule In Group
<power-bi-rest:patch-groups-datasets-refresh-schedule-by-group-id-dataset-id>
Updates the refresh schedule for the specified dataset from the specified workspace. This operation is only supported for the dataset owner. A request that disables the refresh schedule should contain no other changes. The days array should not be set to empty array. The times can be set to an empty array (in which case Power BI will use a default single time per day). The limit on number of time slots per day depends on the type of capacity used (Premium or Shared).
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PATCH request to the /groups/{groupId}/datasets/{datasetId}/refreshSchedule endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<power-bi-rest:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Resource Owner Id |
String |
The ID of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
Datasets PutTable
<power-bi-rest:update-datasets-tables-by-dataset-id-table-name>
Updates the metadata and schema for the specified table within the specified dataset from "My Workspace". Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PUT request to the /datasets/{datasetId}/tables/{tableName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Datasets PutTableInGroup
<power-bi-rest:update-groups-datasets-tables-by-group-id-dataset-id-table-name>
Updates the metadata and schema for the specified table, within the specified dataset, from the specified workspace. Note: This API supports only Push datasets.
Required scope: Dataset.ReadWrite.All
This operation makes an HTTP PUT request to the /groups/{groupId}/datasets/{datasetId}/tables/{tableName} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Dataset Id |
String |
Dataset Id |
x |
|
Table Name |
String |
Table Name |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Update Group User
<power-bi-rest:update-groups-users-by-group-id>
Updates the specified user permissions to the specified workspace. Notes: Users permissions that have been recently updated cannot have their new permissions immediately updated.
Required scope: Workspace.ReadWrite.All
This operation makes an HTTP PUT request to the /groups/{groupId}/users endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Group Id |
String |
Group Id |
x |
|
Content Type |
String |
Content Type |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Throws
-
POWER-BI-REST:BAD_REQUEST
-
POWER-BI-REST:CLIENT_ERROR
-
POWER-BI-REST:CONNECTIVITY
-
POWER-BI-REST:INTERNAL_SERVER_ERROR
-
POWER-BI-REST:NOT_ACCEPTABLE
-
POWER-BI-REST:NOT_FOUND
-
POWER-BI-REST:RETRY_EXHAUSTED
-
POWER-BI-REST:SERVER_ERROR
-
POWER-BI-REST:SERVICE_UNAVAILABLE
-
POWER-BI-REST:TIMEOUT
-
POWER-BI-REST:TOO_MANY_REQUESTS
-
POWER-BI-REST:UNAUTHORIZED
-
POWER-BI-REST:UNSUPPORTED_MEDIA_TYPE
Types
Proxy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
TLS
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom OCSP Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance is allowed to remain idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of allocated memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |