Overview
Configuration is provided for establishing connections with Power BI service. The configuration is used in the REST Connection Manager.
Setup
Press icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Power BI REST API using COZYROC's REST Connection Manager.
Step 3: If your APP
is setup as an Multi-Tenant APP
on Azure Portal then provide your APP
client_id for the client_id parameter and leave the client_secret blank. The Tenant needs be set as default value common
. If your APP
is setup as an Single-Tenant APP
on Azure Portal then provide your APP
client_id client_secret and tenant_id. Then hit the Next Button to startup the token generation process.
Congratulations! You have now established a connection to your Power BI instance.
In this guide, we will show how to read data to the Power BI service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Power BI service resource using the COZYROC REST Destination component.
- You can follow the KB article called How to get a new REST token for tips on how to use the wizard to successfully create the token.
Configuration
Base URL address: https://api.powerbi.com/v1.0/myorg
.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The authentication has the following user-defined parameters:
- client_id: Required. Identifier of application that is associated with the authentication token.
- client_secret: Specify application client secret. Optional.
- tenant: Required. Specify tenant identifier.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.microsoft.com/en-us/azure/active-directory/azuread-dev/v1-protocols-oauth-code.
Based on resource template Admin.
- [Read admin] action
-
Endpoint URL address:
/admin/capacities/refreshables
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/get-refreshables.
- [Read admin-capacity] action
-
Endpoint URL address:
/admin/capacities/{{=parameters.capacityId}}/refreshables
.The action has the following user-defined parameters:
- capacityId: Required. Specify capacity identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/get-refreshables-for-capacity.
- [Read capacity] action
-
Endpoint URL address:
/capacities/{{=parameters.capacityId}}/refreshables
.The action has the following user-defined parameters:
- capacityId: Required. Specify capacity identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-refreshables-for-capacity.
The resource includes the fields from the refreshableT template.
Based on resource template Admin.
- [Read] action
-
Endpoint URL address:
/admin/activityevents
.
The result is extracted from:{{=response.activityEventEntities}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/get-activity-events.
- Id
A key field. Template: ShortText.
- CreationTime
Template: DateTime.
- Operation
Template: ShortText.
- OrganizationId
Template: ShortText.
- UserKey
Template: ShortText.
- Activity
Template: ShortText.
- Workload
Template: ShortText.
- UserId
Template: ShortText.
- ClientIP
Template: ShortText.
Based on resource template Admin.
- [Read] action
-
Endpoint URL address:
/admin/tenantKeys
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/get-power-bi-encryption-keys.
The resource includes the fields from the tenantKeyT template.
Based on resource template Admin.
- [Read] action
-
Endpoint URL address:
/admin/groups/{{=parameters.groupId}}/unused
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-unused-artifacts-as-admin.
- artifactId
Template: ShortText.
- artifactSizeInMB
Data type: DT_I4
- artifactType
Template: ShortText.
- createdDateTime
Template: DateTime.
- displayName
Template: ShortText.
- lastAccessedDateTime
Template: DateTime.
Based on resource template Admin.
- [Read shared] action
-
Endpoint URL address:
/admin/widelySharedArtifacts/linksSharedToWholeOrganization
.
The result is extracted from:{{=response.artifactAccessEntities}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/widely-shared-artifacts-links-shared-to-whole-organization.
- [Read published] action
-
Endpoint URL address:
/admin/widelySharedArtifacts/publishedToWeb
.
The result is extracted from:{{=response.artifactAccessEntities}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/widely-shared-artifacts-published-to-web.
- artifactId
Template: ShortText.
- displayName
Template: ShortText.
- artifactType
Template: ShortText.
- accessRight
Template: ShortText.
- shareType
Template: ShortText.
- sharer
Template: sharerT.
Based on resource template Base.
- [Read artifactAccess] action
-
Endpoint URL address:
/admin/users/{{=parameters.userId}}/artifactAccess
.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/users-get-user-artifact-access-as-admin.
- artifactId
Template: ShortText.
- displayName
Template: ShortText.
- artifactType
Template: ShortText.
- accessRight
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/admin/workspaces/scanResult/{{=parameters.scanId}}
.
The result is extracted from:{{=response.workspaces}}
.The action has the following user-defined parameters:
- scanId: Required. Specify scan identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/workspace-info-get-scan-result.
- id
A key field. Template: ShortText.
- datasetId
Template: ShortText.
- name
Template: ShortText.
- webUrl
Template: ShortText.
- embedUrl
Template: ShortText.
- appId
Template: ShortText.
- createdBy
Template: ShortText.
- createdDateTime
Template: DateTime.
- description
Template: ShortText.
- reportType
Template: ShortText.
- title
Template: ShortText.
- artifactId
Template: ShortText.
- artifactDisplayName
Template: ShortText.
- subArtifactDisplayName
Template: ShortText.
- isEnabled
Data type: DT_BOOL
- frequency
Template: ShortText.
- startDate
Template: Date.
- endDate
Template: Date.
- linkToContent
Data type: DT_BOOL
- previewImage
Data type: DT_BOOL
- attachmentFormat
Template: ShortText.
- type
Template: ShortText.
- state
Template: ShortText.
- isOnDedicatedCapacity
Data type: DT_BOOL
- reports
Field components:
- An array.
- Contains the following components: id, name, datasetId, createdDateTime, modifiedDateTime, modifiedBy, reportType, endorsementDetails, sensitivityLabel, users.
- dashboards
Field components:
- An array.
-
Uses template:
dashboardT
. - Contains the following components: tiles, sensitivityLabel, users.
- datasets
Field components:
- An array.
- Contains the following components: id, name, tables, relationships, configuredBy, targetStorageMode, endorsementDetails, upstreamDataflows, datasourceUsages, sensitivityLabel, users.
- dataflows
Field components:
- An array.
-
Uses template:
dataflowT
. - Contains the following components: endorsementDetails, datasourceUsages, sensitivityLabel, users.
- users
Field components:
- An array.
-
Uses template:
userT
.
- status
The value is gathered from
/admin/workspaces/scanStatus/{{=item.id}}
address. Field components:-
Uses template:
Id
. - Contains the following components: id, createdDateTime, status.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/apps
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-apps.
- [Read Single] action
-
Endpoint URL address:
/apps/{{=PowerBI.UI.AppEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- appId: Required. Specify app identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-app.
- [Read admin] action
-
Endpoint URL address:
/admin/apps
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/apps-get-apps-as-admin.
- id
A key field. Template: ShortText.
- description
Template: ShortText.
- name
Template: ShortText.
- publishedBy
Template: ShortText.
- workspaceId
Template: ShortText.
- users
Field components:
- An array.
-
Uses template:
userT
.
- lastUpdate
Template: DateTime.
- reports
The value is gathered from
/apps/{{=item.id}}/reports
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: appId, id, embedUrl, webUrl, datasetId, name.
- adminUsers
The value is gathered from
/admin/apps/{{=item.id}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
- dashboards
The value is gathered from
/apps/{{=item.id)}}/dashboards
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
dashboardT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/availableFeatures
.
The result is extracted from:{{=response.features}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/available-features/get-available-features.
- [Read Single] action
-
Endpoint URL address:
/availableFeatures(featureName={{=sq(parameters.name)}})
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- name: Required. Specify feature name.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-tiles.
- name
Template: ShortText.
- state
Template: ShortText.
- extendedState
Template: ShortText.
- additionalInfo
Field components:
- Contains the following components: usage.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/capacities
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/capacities/get-capacities#capacities.
- [Read admin] action
-
Endpoint URL address:
/admin/capacities
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/get-capacities-as-admin.
- id
A key field. Template: ShortText.
- admins
Template: StringList.
- createdTime
Template: DateTime.
- displayName
Template: ShortText.
- capacityUserAccessRight
Template: ShortText.
- tenantKeyId
Template: ShortText.
- region
Template: ShortText.
- sku
Template: ShortText.
- state
Template: ShortText.
- users
Field components:
- An array.
-
Uses template:
userT
.
- tenantKey
Template: tenantKeyT.
- refreshables
The value is gathered from
/capacities/{{=item.id}}/refreshables
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
refreshableT
.
- workloads
The value is gathered from
/capacities/{{=item.id}}/workloads
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: maxMemoryPercentageSetByUser, name, state.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dashboards
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/get-dashboards.
- [Read Single] action
-
Endpoint URL address:
/dashboards/{{=PowerBI.UI.DashboardEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- dashboardId: Required. Specify dashboard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/get-dashboard.
- [Read app] action
-
Endpoint URL address:
/apps/{{=PowerBI.UI.AppEditor.getValue(parameters)}}/dashboards
.The action has the following user-defined parameters:
- appId: Required. Specify app identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-dashboards.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/dashboards
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/get-dashboards-in-group.
- [Read admin] action
-
Endpoint URL address:
/admin/dashboards
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dashboards-get-dashboards-as-admin.
- [Read admin-group] action
-
Endpoint URL address:
/admin/groups/{{=PowerBI.UI.GroupEditor.getValue(parameters)}}/dashboards
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dashboards-get-dashboards-in-group-as-admin.
- [Create] action
-
Endpoint URL address:
/dashboards
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/add-dashboard.
- [Delete] action
-
Endpoint URL address:
/dashboards/{{=item.id}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dashboards/delete-dashboard.
The resource includes the fields from the dashboardT template.
- users
Field components:
- An array.
-
Uses template:
userT
.
- subscriptions
Template: subscriptionT.
- tiles
Template: tilesT. The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/dashboards/{{=item.id}}/tiles
address. The gathered value is processed with{{=response.value}}
expression.- adminTiles
Template: tilesT. The value is gathered from
/admin/dashboards/{{=item.id}}/tiles
address. The gathered value is processed with{{=response.value}}
expression.- adminUsers
The value is gathered from
/admin/dashboards/{{=item.id}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/dataflowStorageAccounts
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dataflow-storage-accounts/get-dataflow-storage-accounts.
- [Create] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(item.groupId)}}/AssignToDataflowStorage
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dataflow-storage-accounts/groups-assign-to-dataflow-storage.
- id
A key field. Template: Id.
- name
Template: ShortText.
- isEnable
Data type: DT_BOOL
- groupId
Template: Id.
Based on resource template Base.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/dataflows
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflows.
- [Read admin] action
-
Endpoint URL address:
/admin/dataflows
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dataflows-get-dataflows-as-admin.
- [Read admin-group] action
-
Endpoint URL address:
/admin/groups/{{=PowerBI.UI.GroupEditor.getValue(parameters)}}/dataflows
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dataflows-get-dataflows-in-group-as-admin.
- [Read admin-upstreamDataflow] action
-
Endpoint URL address:
/admin/groups/{{=PowerBI.UI.GroupEditor.getValue(parameters)}}/dataflows/{{=parameters.dataflowId}}/upstreamDataflows
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- dataflowId: Required. Specify dataflow identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dataflows-get-upstream-dataflows-in-group-as-admin.
The resource includes the fields from the dataflowT template.
- datasources
The value is gathered from
{{=PowerBI.getGroupBase(parameters.groupId)}}/dataflows/{{=item.id}}/datasources
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
datasourceT
.
- transactions
The value is gathered from
{{=PowerBI.getGroupBase(parameters.groupId)}}/dataflows/{{=item.id}}/transactions
address. Field components:- An array.
- Contains the following components: id, endTime, refreshType, startTime, status.
- upstreamDataflows
The value is gathered from
{{=PowerBI.getGroupBase(parameters.groupId)}}/dataflows/{{=item.id}}/upstreamDataflows
address. Field components:- An array.
- Contains the following components: groupId, targetDataflowId.
- users
The value is gathered from
/admin/dataflows/{{=item.id}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
- adminDatasources
The value is gathered from
/admin/dataflows/{{=item.id}}/datasources
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
datasourceT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/datasets
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasets.
- [Read Single] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-dataset.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/datasets
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasets-in-group.
- [Read admin] action
-
Endpoint URL address:
/admin/datasets
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasets-as-admin.
- [Read admin-group] action
-
Endpoint URL address:
/admin/groups/{{=PowerBI.UI.GroupEditor.getValue(parameters)}}/datasets
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasets-in-group-as-admin.
- [Create] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/datasets
.The action has the following user-defined parameters:
- groupId: Specify group identifier. Optional.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-dataset.
- [Update] action
-
Endpoint URL address:
/datasets/{{=item.id}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/update-dataset.
- [Delete] action
-
Endpoint URL address:
/datasets/{{=item.id}}
.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- addRowsAPIEnabled
Data type: DT_BOOL
- configuredBy
Template: ShortText.
- targetStorageMode
Template: ShortText.
- isRefreshable
Data type: DT_BOOL
- isEffectiveIdentityRequired
Data type: DT_BOOL
- isEffectiveIdentityRolesRequired
Data type: DT_BOOL
- isOnPremGatewayRequired
Data type: DT_BOOL
- IsRefreshable
Data type: DT_BOOL
- createReportEmbedURL
Template: ShortText.
- qnaEmbedURL
Template: ShortText.
- description
Template: ShortText.
- webUrl
Template: ShortText.
- ContentProviderType
Template: ShortText.
- Encryption
Template: ShortText.
- CreatedDate
Template: DateTime.
- upstreamDataflows
Template: upstreamDataflowT.
- groupId
Template: Id.
- defaultMode
Template: ShortText.
- users
The value is gathered from
{{=PowerBI.getDatasetBase(item.id)}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
- datasources
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/datasources
address. The gathered value is processed with{{=response.value}}
expression. The value is sent to{{=PowerBI.getGroupBase(item.groupId) + PowerBI.getDatasetBase(item.id)}}/Default.UpdateDatasources
address. Field components:- An array.
-
Uses template:
datasourceT
.
- directQueryRefreshSchedule
Template: refreshScheduleT. The value is gathered from
{{=PowerBI.getDatasetBase(item.id)}}/directQueryRefreshSchedule
address. The value is sent to{{=PowerBI.getDatasetBase(item.id)}}/directQueryRefreshSchedule
address.- gatewayDatasources
The value is gathered from
{{=PowerBI.getDatasetBase(item.id)}}/Default.GetBoundGatewayDatasources
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
datasourceT
.
- parameters
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/parameters
address. The gathered value is processed with{{=response.value}}
expression. The value is sent to{{=PowerBI.getGroupBase(item.groupId) + PowerBI.getDatasetBase(item.id)}}/Default.UpdateParameters
address. Field components:- An array.
-
Uses template:
ParameterT
. - Contains the following components: suggestedValues, newValue.
- refreshHistory
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/refreshes
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
RefreshHistoryT
.
- refreshSchedule
Template: refreshScheduleT. The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/refreshSchedule
address. The value is sent to{{=PowerBI.getGroupBase(item.groupId) + PowerBI.getDatasetBase(item.id)}}/refreshSchedule
address.- tables
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/tables
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
TableT
.
- discoverGateways
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(item.id)}}/Default.DiscoverGateways
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: id, name, type, publicKey.
- bindToGateway
The value is sent to
{{=PowerBI.getGroupBase(item.groupId) + PowerBI.getDatasetBase(item.id)}}/Default.BindToGateway
address. Field components:-
Uses template:
ShortText
. - Contains the following components: gatewayObjectId, datasourceObjectIds.
-
Uses template:
- adminUsers
The value is gathered from
/admin/datasets/{{=item.id}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
- adminDatasources
The value is gathered from
/admin/datasets/{{=item.id}}/datasources
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
datasourceT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/executeQueries
.
The result is extracted from:{{=response.results[0].tables[0].rows}}
.
The action uses POST method.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
- query: Required. Specify DAX query.
The following request parameters will be automatically processed:
-
application/json:
{{={ queries: [{ query: 'EVALUATE ' + parameters.query }], serializerSettings: { includeNulls: true } } }}
- [External]
-
The external fields URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/executeQueries
. The external fields list is extracted from:{{=PowerBI.getQueryFields(response.results[0].tables[0].rows)}}
.- {{=external.name}}
Template: {{=external.template}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/refreshes
.
The result is paginated.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
The following request parameters will be automatically processed:
-
$skiptoken:
{{=parameters.iterator}}
-
$top:
{{=parameters.batchSize}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId) + PowerBI.getDatasetBase(parameters.datasetId)}}/refreshes
.
The result is paginated.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- datasetId: Required. Specify dataset identifier.
The following request parameters will be automatically processed:
-
$skiptoken:
{{=parameters.iterator}}
-
$top:
{{=parameters.batchSize}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-refresh-history-in-group.
- refreshType
Template: ShortText.
- status
Template: ShortText.
- requestId
Template: ShortText.
- serviceExceptionJson
Template: ShortText.
- startTime
Template: DateTime.
- endTime
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/gateways
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-gateways.
- [Read Single] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-gateway.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- publicKey
Field components:
-
Uses template:
ShortText
. - Contains the following components: exponent, modulus.
-
Uses template:
- datasources
Template: datasourceT. The value is gathered from
/gateways/{{=item.id}}/datasources
address. The gathered value is processed with{{=response.value}}
expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasources.
- [Read Single] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=parameters.datasourceId}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
- datasourceId: Required. Specify datasource identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasource.
- [Create] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/create-datasource.
- [Update] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=item.id}}
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ credentialDetails : item } }}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/update-datasource.
- [Delete] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=item.id}}
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/delete-datasource.
- id
A key field. Template: ShortText.
- gatewayId
Template: ShortText.
- datasourceType
Template: ShortText.
- credentialType
Template: ShortText.
- datasourceName
Template: ShortText.
- credentials
Field components:
- An array.
- Contains the following components: name, key, value.
- connectionDetails
Template: connectionDetailsT.
- status
Template: LongText. A composite field. The value is gathered from
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=item.id}}/status
address.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=parameters.datasourceId}}/users
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
- datasourceId: Required. Specify datasource identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasource-users.
- [Create] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=parameters.datasourceId}}/users
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
- datasourceId: Required. Specify datasource identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/add-datasource-user.
- [Delete] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=parameters.datasourceId}}/users/{{=item.identifier}}
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
- datasourceId: Required. Specify datasource identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/delete-datasource-user.
- datasourceAccessRight
Template: ShortText.
- displayName
Template: ShortText.
- emailAddress
Template: ShortText.
- identifier
A key field. Template: ShortText.
- principalType
Template: ShortText.
Based on resource template Group.
- [Create] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/goalValues({{=parameters.timestamp}})/notes
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/post#code-try-0.
- [Update] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/goalValues({{=parameters.timestamp}})/notes({{=item.noteId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/patch-by-id.
- [Delete] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/goalValues({{=parameters.timestamp}})/notes({{=parameters.noteId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/delete-user-in-group.
- noteId
A key field. Template: ShortText.
- body
Template: LongText.
- valueTimestamp
Template: ShortText.
- goalId
Template: ShortText.
- scorecardId
Template: ShortText.
- lastModifiedTime
Template: DateTime.
- content
Template: ShortText.
- createdTime
Template: DateTime.
Based on resource template Group.
- [Read] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/goalValues
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/post#code-try-0.
- [Read Single] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/goalValues({{=parameters.timestamp}})
.
The result is extracted from:{{=response]}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/post#code-try-0.
- [Update] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=item.goalId}})/goalValues({{=parameters.timestamp}})/notes({{=item.noteId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/patch-by-id.
- [Delete] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=item.goalId}})/goalValues({{=parameters.timestamp}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- timestamp: Required. Specify timestamp in format 2021-12-14.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/patch-by-id.
- timestamp
Template: ShortText.
- goalId
Template: ShortText.
- scorecardId
Template: ShortText.
- forecast
Template: Number.
- createdTime
Template: DateTime.
- lastModifiedTime
Template: DateTime.
- value
Template: Number.
- target
Data type: DT_I4
- status
Data type: DT_I4
- valueDisplayString
Template: ShortText.
- targetDisplayString
Template: ShortText.
- trend
Template: ShortText.
- notes
Template: noteT.
Based on resource template Group.
- [Read] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals/get.
- [Read Single] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals/get-by-id.
- [Create] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals/post.
- [Update] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=item.id}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals/patch-by-id.
- [Delete] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=item.goalId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goal-notes/patch-by-id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- scorecardId
Template: ShortText.
- valuesFormatString
Template: ShortText.
- createdTime
Template: DateTime.
- completionDate
Template: DateTime.
- lastModifiedTime
Template: DateTime.
- datesFormatString
Template: DateTime.
- startDate
Template: DateTime.
- notesCount
Data type: DT_I4
- hasStatusRules
Data type: DT_BOOL
- permissions
Template: ShortText.
- description
Template: ShortText.
- parentId
Template: ShortText.
- level
Data type: DT_I4
- rank
Data type: DT_I4
- aggregations
Template: aggretationT.
- goalValues
Template: goalValueT.
- statusRules
Template: statusRuleT.
Based on resource template Group.
- [Read] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/statusRules
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goal identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals-status-rules/get.
- [Create] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/statusRules
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goalId identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals-status-rules/post.
- [Delete] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})/goals({{=parameters.goalId}})/statusRules
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
- goalId: Required. Specify goalId identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/goals-status-rules/delete.
- defaultOutput
Template: ShortText.
- goalObjectId
Template: ShortText.
- lastModifiedTime
Template: DateTime.
- scorecardObjectId
Template: ShortText.
- notes
Template: noteT.
- rules
Field components:
- An array.
- Contains the following components: output, conditions.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups
.
The result is paginated.The following request parameters will be automatically processed:
-
$skip:
{{=parameters.iterator}}
-
$top:
{{=parameters.batchSize}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/get-groups.
-
$skip:
- [Read admin] action
-
Endpoint URL address:
/admin/groups
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-groups-as-admin.
- [Create] action
-
Endpoint URL address:
/groups
.The action has the following user-defined parameters:
- workspaceV2: Accepted value is boolean. Optional.
The following request parameters will be automatically processed:
-
workspaceV2:
{{=parameters.get('workspaceV2')}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/create-group.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}
.
- id
A key field. Template: ShortText.
- dataflowStorageId
Template: ShortText.
- capacityId
Template: ShortText.
- isReadOnly
Data type: DT_BOOL
- isOnDedicatedCapacity
Data type: DT_BOOL
- name
Template: ShortText.
- CapacityAssignmentStatus
The value is gathered from
{{=PowerBI.getGroupBase(item.id)}}/CapacityAssignmentStatus
address. The gathered value is processed with{{=[response]}}
expression. Field components:-
Uses template:
ShortText
. - Contains the following components: status, activityId, capacityId, startTime, endTime.
-
Uses template:
- dataflows
The value is gathered from
/admin/groups/{{=item.id}}/datasets/upstreamDataflows
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: datasetObjectId, dataflowObjectId, workspaceObjectId.
- parameters
The value is sent to
{{=PowerBI.getGroupBase(item.id) + PowerBI.getDatasetBase(parameters.datasetId)}}/Default.UpdateParameters
address. Field components:- An array.
-
Uses template:
ParameterT
.
- capacityAssignmentStatus
The value is gathered from
{{=PowerBI.getGroupBase(item.id)}}/CapacityAssignmentStatus
address. Field components:-
Uses template:
StringList
. - Contains the following components: status, activity, startTime, endTime, capacityId.
-
Uses template:
- dashboards
The value is gathered from
{{=PowerBI.getGroupBase(item.id)}}/dashboards
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
dashboardT
.
Based on resource template Group.
- [Read] action
-
Endpoint URL address:
/users
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/get-group-users.
- [Create] action
-
Endpoint URL address:
/users
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/create-group.
- [Update] action
-
Endpoint URL address:
/users
.
The action uses PUT method.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/update-group-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.identifier}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/delete-user-in-group.
- displayName
Template: ShortText.
- emailAddress
Template: ShortText.
- groupUserAccessRight
Template: ShortText.
- identifier
A key field. Template: ShortText.
- principalType
Template: ShortText.
- graphId
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/imports
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/imports/get-imports.
- [Read Single] action
-
Endpoint URL address:
/imports/{{=PowerBI.UI.ImportEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- importId: Required. Specify import identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/imports/get-import.
- [Read admin] action
-
Endpoint URL address:
/admin/imports
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/imports-get-imports-as-admin.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/imports
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/imports/get-imports-in-group.
- id
A key field. Template: Id.
- importState
Template: ShortText.
- createdDateTime
Template: DateTime.
- updatedDateTime
Template: DateTime.
- name
Template: ShortText.
- connectionType
Template: ShortText.
- source
Template: ShortText.
- datasets
Field components:
- An array.
-
Uses template:
datasetT
.
- reports
Field components:
- An array.
-
Uses template:
reportT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipelines
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dataflow-storage-accounts/get-dataflow-storage-accounts.
- [Read Single] action
-
Endpoint URL address:
/pipelines/{{=PowerBI.UI.PipelineEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline.
- [Read admin] action
-
Endpoint URL address:
/admin/pipelines
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipelines-as-admin.
- [Create] action
-
Endpoint URL address:
/pipelines
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/create-pipeline.
- [Update] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/update-pipeline.
- [Delete] action
-
Endpoint URL address:
/pipelines/{{=item.id}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/delete-pipeline.
- id
A key field. Template: ShortText.
- displayName
Template: ShortText.
- description
Template: ShortText.
- users
The value is gathered from
/pipelines/{{=item.id}}/users
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
userT
.
- operations
The value is gathered from
/pipelines/{{=item.id}}/operations
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: id, type, status, lastUpdatedTime, executionStartTime, executionEndTime, sourceStageOrder, targetStageOrder, executionPlan.
- stages
The value is gathered from
/pipelines/{{=item.id}}/stages
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: order, workspaceId, workspaceName.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipelines/{{=PowerBI.UI.PipelineEditor.getValue(parameters)}}/users
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline-users.
- [Update] action
-
Endpoint URL address:
/pipelines/{{=PowerBI.UI.PipelineEditor.getValue(parameters)}}/users
.
The action uses POST method.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/update-pipeline-user.
- [Delete] action
-
Endpoint URL address:
/pipelines/{{=PowerBI.UI.PipelineEditor.getValue(parameters)}}/users/{{=item.identifier}}
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/delete-pipeline.
The resource includes the fields from the userT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pipelines/{{=PowerBI.UI.PipelineEditor.getValue(parameters)}}/stages/{{=parameters.stageOrder}}/artifacts
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
- stageOrder: Required. Specify stageOrder.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline-stage-artifacts.
- dataflows
Template: stageArtifactT.
- datasets
Template: stageArtifactT.
- reports
Template: stageArtifactT.
- dashboards
Template: stageArtifactT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/tables
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-get-tables.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId) + PowerBI.getDatasetBase(parameters.datasetId)}}/tables
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-get-tables-in-group.
- [Update] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(parameters.datasetId)}}/tables/{{=item.name}}
.
The action uses PUT method.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
- groupId: Specify group identifier. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ name : item.name }, item)}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-put-table.
The resource includes the fields from the TableT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(parameters.datasetId)}}/tables/{{=parameters.tableName}}/rows
.
The result is extracted from:{{=undefined}}
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
- tableName: Required. Specify table name.
- groupId: Specify group identifier. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{={ rows : batch } }}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/push-datasets/datasets-post-rows.
- tableName
A key field. Template: ShortText.
- [External]
-
The external fields URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId')) + PowerBI.getDatasetBase(parameters.datasetId)}}/executeQueries
. The external fields list is extracted from:{{=PowerBI.getTableFields(response.results[0].tables[0].rows)}}
.- {{=external.name}}
Template: {{=external.template}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports
.The action has the following user-defined parameters:
- groupId: Specify group identifier. Optional.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/get-reports.
- [Read Single] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=PowerBI.UI.ReportEditor.getValue(parameters)}}
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- reportId: Required. Specify report identifier.
- groupId: Specify group identifier. Optional.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/get-report.
- [Read admin] action
-
Endpoint URL address:
/admin/reports
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-reports-as-admin.
- [Read admin-group] action
-
Endpoint URL address:
/admin/groups/{{=PowerBI.UI.GroupEditor.getValue(parameters)}}/reports
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-reports-in-group-as-admin.
- [Read app] action
-
Endpoint URL address:
/apps/{{=PowerBI.UI.AppEditor.getValue(parameters)}}/reports
.The action has the following user-defined parameters:
- appId: Required. Specify app identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/apps/get-reports.
- [Update] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=PowerBI.UI.ReportEditor.getValue(parameters)}}/UpdateReportContent
.
The action uses POST method.The action has the following user-defined parameters:
- reportId: Required. Specify report identifier.
- groupId: Specify group identifier. Optional.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/update-report-content#code-try-0.
- [Delete] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=item.id}}
.The action has the following user-defined parameters:
- groupId: Specify group identifier. Optional.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/delete-report.
The resource includes the fields from the reportT template.
- createdBy
Template: ShortText.
- createdDateTime
Template: DateTime.
- datasources
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=item.id}}/datasources
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
-
Uses template:
datasourceT
.
- pages
The value is gathered from
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=item.id}}/pages
address. The gathered value is processed with{{=response.value}}
expression. Field components:- An array.
- Contains the following components: displayName, Name, order.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.get('groupId'))}}/reports/{{=PowerBI.UI.ReportEditor.getValue(parameters)}}/ExportTo
.
The action uses POST method.The action has the following user-defined parameters:
- reportType: Required. Specify report type.
- reportId: Required. Specify report identifier.
- groupId: Specify group identifier. Optional.
The following request parameters will be automatically processed:
-
application/json:
{{=function() { var result = { format : item.format }; result[parameters.reportType] = item; return result; }()}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/export-to-file.
- format
Template: ShortText.
- formatSettings
Template: LongText. A composite field.
- identities
Field components:
- An array.
-
Uses template:
identityT
.
- parameterValues
Field components:
- An array.
-
Uses template:
parameterValueT
.
- pages
Field components:
- An array.
-
Uses template:
ExportPageT
.
- reportLevelFilters
Field components:
- An array.
- defaultBookmark
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, value.
-
Uses template:
- settings
Field components:
-
Uses template:
ShortText
. - Contains the following components: includeHiddenPages, locale.
-
Uses template:
Based on resource template Group.
- [Read] action
-
Endpoint URL address:
/scorecards
.
The result is paginated.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
The following request parameters will be automatically processed:
-
$skiptoken:
{{=parameters.iterator}}
-
$top:
{{=parameters.batchSize}}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/get.
- [Read Single] action
-
Endpoint URL address:
/scorecards({{=parameters.scorecardId}})
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- scorecardId: Required. Specify scorecard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/get-by-id.
- [Read Report] action
-
Endpoint URL address:
/scorecards/GetScorecardByReportId(reportId={{=sq(parameters.reportId)}})
.
The result is extracted from:{{=[response]}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- reportId: Required. Specify report identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/get-scorecard-by-report-id.
- [Create] action
-
Endpoint URL address:
/scorecards
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/post.
- [Update] action
-
Endpoint URL address:
/scorecards({{=item.scorecardId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/patch-by-id.
- [Delete] action
-
Endpoint URL address:
/scorecards({{=item.scorecardId}})
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/scorecards/delete-by-id.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- createdTime
Template: DateTime.
- lastModifiedTime
Template: DateTime.
- completionDate
Template: DateTime.
- provisioningStatus
Template: ShortText.
- datesFormatString
Template: ShortText.
- description
Template: ShortText.
- parentId
Template: ShortText.
- valuesFormatString
Template: ShortText.
- groupId
Template: ShortText.
- datasetId
Template: ShortText.
- reportId
Template: ShortText.
- permissions
Template: ShortText.
- statuses
Field components:
- An array.
- Contains the following components: id, displayName, color, historical.
- aggregations
Template: aggretationT.
- goalValues
Template: goalValueT.
- statusRules
Template: statusRuleT.
- columnSettings
Field components:
- An array.
- Contains the following components: columnId, show.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/CreateTemplateAppInstallTicket
.The following request parameters will be automatically processed:
-
application/json:
{{={installDetails : [item] } }}
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/template-apps.
-
application/json:
- appId
Template: ShortText.
- ownerTenantId
Template: ShortText.
- packageKey
Template: ShortText.
- config
Template: LongText. A composite field.
Based on resource template Base.
- [Read admin-capacity] action
-
Endpoint URL address:
/admin/capacities/{{=parameters.capacityId}}/users
.The action has the following user-defined parameters:
- capacityId: Required. Specify capacity identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/capacities-get-capacity-users-as-admin.
- [Read admin-dataset] action
-
Endpoint URL address:
/admin/datasets/{{=parameters.datasetId}}/users
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-dataset-users-as-admin.
- [Read admin-group] action
-
Endpoint URL address:
/admin/groups/{{=parameters.groupId}}/users
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-group-users-as-admin.
- [Read admin-pipeline] action
-
Endpoint URL address:
/admin/pipelines/{{=parameters.pipelineId}}/users
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/pipelines-get-pipeline-users-as-admin.
- [Read report] action
-
Endpoint URL address:
/admin/reports/{{=parameters.reportId}}/users
.The action has the following user-defined parameters:
- reportId: Required. Specify report identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-report-users-as-admin.
- [Read datasource] action
-
Endpoint URL address:
/gateways/{{=PowerBI.UI.GatewayEditor.getValue(parameters)}}/datasources/{{=parameters.datasourceId}}/users
.The action has the following user-defined parameters:
- gatewayId: Required. Specify gateway identifier.
- datasourceId: Required. Specify datasource identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasource-users.
- [Read group] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/users
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/groups/get-group-users.
- [Read pipeline] action
-
Endpoint URL address:
/pipelines/{{=parameters.pipelineId}}/users
.The action has the following user-defined parameters:
- pipelineId: Required. Specify pipeline identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/pipelines/get-pipeline-users.
The resource includes the fields from the userT template.
Based on resource template Base.
- [Read admin-report] action
-
Endpoint URL address:
/admin/reports/{{=parameters.reportId}}/subscriptions
.The action has the following user-defined parameters:
- reportId: Required. Specify report identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-report-subscriptions-as-admin.
- [Read admin-user] action
-
Endpoint URL address:
/admin/users/{{=parameters.userId}}/subscriptions
.
The result is extracted from:{{=response.subscriptionEntities}}
.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/users-get-user-subscriptions-as-admin.
- [Read admin-dashboard] action
-
Endpoint URL address:
/admin/dashboards/{{=parameters.dashboardId}}/subscriptions
.The action has the following user-defined parameters:
- dashboardId: Required. Specify dashboard identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/dashboards-get-dashboard-subscriptions-as-admin.
The resource includes the fields from the subscriptionT template.
Based on resource template Base.
- [Read group-dataflow] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId)}}/dataflows/{{=parameters.dataflowId}}/datasources
.
The result is extracted from:{{=response.value}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- dataflowId: Required. Specify dataflow identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/dataflows/get-dataflow-data-sources.
- [Read dataset] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/datasources
.
The result is extracted from:{{=response.value}}
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasources.
- [Read dataset-gateway] action
-
Endpoint URL address:
{{=PowerBI.getDatasetBase(parameters.datasetId)}}/Default.GetBoundGatewayDatasources
.
The result is extracted from:{{=response.value}}
.The action has the following user-defined parameters:
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-gateway-datasources.
- [Read group-dataset] action
-
Endpoint URL address:
{{=PowerBI.getGroupBase(parameters.groupId) + PowerBI.getDatasetBase(parameters.datasetId)}}/datasources
.
The result is extracted from:{{=response.value}}
.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
- datasetId: Required. Specify dataset identifier.
Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/datasets/get-datasources-in-group.
- [Read admin] action
-
Endpoint URL address:
/admin/datasets/{{=item.id}}/datasources
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasources-as-admin.
- [Read gateway] action
-
Endpoint URL address:
/gateways/{{=item.id}}/datasources
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/gateways/get-datasources.
- [Read report] action
-
Endpoint URL address:
/reports/{{=item.id}}/datasources
.
The result is extracted from:{{=response.value}}
.Documentation: https://docs.microsoft.com/en-us/rest/api/power-bi/reports/get-datasources.
The resource includes the fields from the datasourceT template.
- [Read] action
-
The result is extracted from:{{=response.value}}
.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The result is extracted from:{{=response.value}}
.
The result is paginated.The following request parameters will be automatically processed:
-
$skip:
{{=parameters.iterator}}
-
$top:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
$skip:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Template: DateTime.
- Date
Data type: DT_DBDATE
- Id
Data type: DT_GUID
- Number
Data type: DT_R8
- StringList
Template: LongText. A composite field. The gathered value is processed with
{{=value && value.join(', ')}}
expression.- userT
Field components:
-
Uses template:
ShortText
. - Contains the following components: identifier, displayName, emailAddress, graphId, datasetUserAccessRight, principalType.
-
Uses template:
- subscriptionT
Field components:
- An array.
- Contains the following components: id, title, artifactId, artifactDisplayName, subArtifactDisplayName, artifactType, isEnabled, frequency, startDate, endDate, linkToContent, previewImage, attachmentFormat, users.
- tenantKeyT
Field components:
-
Uses template:
Id
. - Contains the following components: id, name, keyVaultKeyIdentifier, isDefault, createdAt, updatedAt.
-
Uses template:
- dashboardT
Field components:
-
Uses template:
Id
. - Contains the following components: id, appId, displayName, embedUrl, webUrl, name, workspaceId, isReadOnly.
-
Uses template:
- columnT
Field components:
- An array.
- Contains the following components: dataCategory, dataType, formatString, name, sortByColumn, summarizeBy, isHidden.
- measureT
Field components:
- An array.
- Contains the following components: description, expression, formatString, name, isHidden.
- rowT
Field components:
- An array.
- sourceT
Field components:
- An array.
- tilesT
Field components:
- An array.
- Contains the following components: id, title, embedUrl, embedData, rowSpan, colSpan, reportId, datasetId.
- aggretationT
Field components:
- An array.
- Contains the following components: id, timestamp, maxLastModifiedTime, goalId, scorecardId, valueDisplayString, value, calculationTime, type.
- noteT
Field components:
- An array.
- Contains the following components: id, valueTimestamp, goalId, scorecardId, lastModifiedTime, content, createdTime, body.
- goalValueT
Field components:
- An array.
- Contains the following components: id, createdTime, lastModifiedTime, goalId, scorecardId, forecast, status, goalId, scorecardId, target, value, timestamp, trend, targetDisplayString, valueDisplayString, notes.
- statusRuleT
Field components:
-
Uses template:
Id
. - Contains the following components: goalObjectId, rules, scorecardObjectId, lastModifiedTime.
-
Uses template:
- connectionDetailsT
Field components:
-
Uses template:
ShortText
. - Contains the following components: server, database, kind, value, path.
-
Uses template:
- sharerT
Field components:
-
Uses template:
ShortText
. - Contains the following components: displayName, emailAddress, identifier, graphId, principalType.
-
Uses template:
- lastFreshT
Field components:
-
Uses template:
ShortText
. - Contains the following components: refreshType, startTime, endTime, status, requestId.
-
Uses template:
- refreshScheduleT
Field components:
-
Uses template:
LongText
. - Contains the following components: days, times, enabled, localTimeZoneId, notifyOption.
-
Uses template:
- refreshableT
Field components:
-
Uses template:
Id
. - Contains the following components: id, name, kind, startTime, endTime, refreshCount, refreshFailures, averageDuration, medianDuration, refreshesPerDay, lastRefresh, refreshSchedule, configuredBy, capacity, group.
-
Uses template:
- stageArtifactT
Field components:
- An array.
- Contains the following components: artifactId, artifactDisplayName, sourceArtifactId, lastDeploymentTime.
- datasourceT
Field components:
-
Uses template:
connectionDetailsT
. - Contains the following components: datasourceSelector, connectionDetails, name, gatewayId, datasourceType, datasourceId, connectionString.
-
Uses template:
- TableT
Field components:
-
Uses template:
Id
. - Contains the following components: id, name, datasetname, defaultMode, description, isHidden, columns, measures, rows, source.
-
Uses template:
- dataflowT
Field components:
-
Uses template:
Id
. - Contains the following components: objectId, name, description, modelUrl, configuredBy, modifiedBy, modifiedDateTime, users.
-
Uses template:
- endorsementDetailT
Field components:
-
Uses template:
ShortText
. - Contains the following components: endorsement, certifiedBy.
-
Uses template:
- datasourceUsageT
Field components:
- An array.
- sensitivityLabelT
Field components:
-
Uses template:
Id
. - Contains the following components: labelId.
-
Uses template:
- upstreamDataflowT
Field components:
- An array.
- Contains the following components: targetDataflowId, groupId.
- datasetT
Field components:
-
Uses template:
Id
. - Contains the following components: id, name, addRowsAPIEnabled, configuredBy, targetStorageMode, isRefreshable, isEffectiveIdentityRequired, isEffectiveIdentityRolesRequired, isOnPremGatewayRequired, IsRefreshable, createReportEmbedURL, qnaEmbedURL, description, targetStorageMode, webUrl, ContentProviderType, targetStorageMode, Encryption, CreatedDate, upstreamDataflows, users.
-
Uses template:
- pageT
Field components:
-
Uses template:
ShortText
. - Contains the following components: displayName, Name, order.
-
Uses template:
- reportT
Field components:
-
Uses template:
Id
. - Contains the following components: id, name, webUrl, embedUrl, appId, datasetId, description, reportType, export, pages, sourceReport, sourceType, users, subscriptions.
-
Uses template:
- identityT
Field components:
-
Uses template:
ShortText
. - Contains the following components: customData, username, datasets, reports, roles, identityBlob.
-
Uses template:
- parameterValueT
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, value.
-
Uses template:
- ExportPageT
Field components:
-
Uses template:
ShortText
. - Contains the following components: bookmark, pageName, visualName.
-
Uses template:
- ParameterT
Field components:
-
Uses template:
ShortText
. - Contains the following components: name, type, isRequired, currentValue.
-
Uses template:
- RefreshHistoryT
Field components:
-
Uses template:
ShortText
. - Contains the following components: refreshType, status, requestId, serviceExceptionJson, startTime, endTime.
-
Uses template:
Knowledge Base
Related scripts
What's New
- New: Included client_credentials authentication.
- Fixed:
tenant
parameter was not used during OAuth token generation. - Fixed: Various fixes and enhancements (Thank you, Pat).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.