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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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

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

Connection Timeout

Number

Timeout for establishing connections to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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.

https://api.powerbi.com/v1.0/myorg

TLS Configuration

TLS

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.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

Service provider’s access token endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

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.

Operations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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-adress>

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/{emailAdress} 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 Adress

String

Email Adress

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

String

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the Response Timeout.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

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.

Output

Type

Any

Attributes Type

For Configurations

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