Imports - Post Import In Group

Service:
Power BI REST APIs
API Version:
v1.0

Creates new content on the specified workspace from PBIX (Power BI Desktop), JSON, XLSX (Excel), RDL, or file path in OneDrive for Business.

Required scope: Dataset.ReadWrite.All
To set the permissions scope, see Register an app.

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 an RDL file, in the DatasetDisplayName property, include .rdl to define the file type.
  • 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. This is supported only for workspaces on premium capacity.
  • To create a dataflow from a model.json, specify the parameter datasetDisplayName as described below.

Limitations

Post import is not supported for dataflows with service principal.

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/imports?datasetDisplayName={datasetDisplayName}&nameConflict={nameConflict}&skipReport={skipReport}

URI Parameters

Name In Required Type Description
groupId
 path True
  • string
uuid

The workspace id
datasetDisplayName
 query True
  • string

The display name of the dataset should include file extension. Not supported when importing from OneDrive for Business. For importing or creating dataflows, this parameter should be hardcoded to model.json.
nameConflict
 query

Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.
Only Abort and Overwrite are supported with Rdl files.
Only Abort and GenerateUniqueName are supported with dataflow model.json files.
skipReport
 query
  • boolean

Determines whether to skip report import, if specified value must be 'true'. Only supported for PBIX files.

Request Body

Media Types: "application/json", "multipart/form-data"

Name Type Description
connectionType

The import connection type for OneDrive for Business file
filePath
  • string

The OneDrive for Business .xlsx file path to import, can be absolute or relative. .pbix files are not supported.
fileUrl
  • string

The shared access signature (SAS) url of the temporary blob storage, used to import large .pbix files between 1 GB and 10 GB

Responses

Name Type Description
200 OK

OK
202 Accepted

Accepted

Examples

Import dataflow model.json example
Post import example
Post import skip report example

Import dataflow model.json example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=model.json&nameConflict=Abort&skipReport=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data name=model.json; filename=model.json Content-Type: application/json [Contents of Model JSON Encoded] --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Post import skip report example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/cfafbeb1-8037-4d0c-896e-a46fb27ff229/imports?datasetDisplayName=MyReport&nameConflict=Ignore&skipReport=True
Request Body
{
  "value": "--f05e5244-f876-43b9-bc87-d71598f6b32a Content-Disposition: form-data AA...ZZ --f05e5244-f876-43b9-bc87-d71598f6b32a--"
}

Sample Response

Status code:
202 
{
  "id": "d02b8896-e247-4d83-ae5a-014028cb0665"
}

Definitions

connectionType

The import connection type for OneDrive for Business file
Dataset

A Power BI dataset
DatasourceUsage

Datasource usage
DependentDataflow

A Power BI Dependent dataflow
Encryption

Encryption information for a dataset
EncryptionStatus

Dataset encryption status
EndorsementDetails

Power BI endorsement details
Import

The import object
ImportConflictHandlerMode

Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.
Only Abort and Overwrite are supported with Rdl files.
Only Abort and GenerateUniqueName are supported with dataflow model.json files.
ImportInfo

The information about the import
Report

A Power BI report
SensitivityLabel

Artifact sensitivity label info

connectionType

The import connection type for OneDrive for Business file

Name Type Description
connect
  • string
import
  • string

Dataset

A Power BI dataset

Name Type Description
ContentProviderType
  • string

The content provider type for the dataset
CreateReportEmbedURL
  • string

The dataset create report embed url
CreatedDate
  • string

DateTime of creation of this dataset
Encryption

The dataset encryption information (Only applicable when $expand is specified)
IsEffectiveIdentityRequired
  • boolean

Whether the dataset requires an effective identity. This indicates that you must send an effective identity using the GenerateToken API.
IsEffectiveIdentityRolesRequired
  • boolean

Whether RLS is defined inside the PBIX file. This indicates that you must specify a role.
IsOnPremGatewayRequired
  • boolean

Dataset requires an On-premises Data Gateway
IsRefreshable
  • boolean

Can this dataset be refreshed
QnaEmbedURL
  • string

The dataset qna embed url
addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows
configuredBy
  • string

The dataset owner
datasourceUsages

Datasource usages
description
  • string

The dataset description
endorsementDetails

The dataset endorsement details
id
  • string

The dataset id
name
  • string

The dataset name
sensitivityLabel

The dataset sensitivity label
upstreamDataflows

Upstream Dataflows
webUrl
  • string

The dataset web url

DatasourceUsage

Datasource usage

Name Type Description
datasourceInstanceId
  • string

The datasource instance ID

DependentDataflow

A Power BI Dependent dataflow

Name Type Description
groupId
  • string

The target group id
targetDataflowId
  • string

The target dataflow id

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings
NotInSyncWithWorkspace
  • string

Encryption is supported and not in sync with the encryption settings
NotSupported
  • string

Encryption is not supported for this dataset
Unknown
  • string

Unable to determine state due to dataset corruption

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact
endorsement
  • string

The endorsement status

Import

The import object

Name Type Description
createdDateTime
  • string

Import creation time
datasets

The datasets associated with this import
id
  • string

The import id
importState
  • string

The import upload state
name
  • string

The import name
reports

The reports associated with this import
updatedDateTime
  • string

Import last update time

ImportConflictHandlerMode

Determines what to do if a dataset with the same name already exists. Default value is 'Ignore'.
Only Abort and Overwrite are supported with Rdl files.
Only Abort and GenerateUniqueName are supported with dataflow model.json files.

Name Type Description
Abort
  • string

If dataset or dataflow with the same name already exists, Import operation will be aborted.
CreateOrOverwrite
  • string

If dataset with the same name already exists, Import operation will replace the existing dataset with the new one.
Import operation will fail if there are more than one datasets with the same name.
GenerateUniqueName
  • string

If a dataflow with the same name already exists, Import operation will generate a new unique name for the dataflow.
Ignore
  • string

If dataset with the same name already exists, Import operation will create a new dataset with the same name.
Overwrite
  • string

If dataset with the same name already exists, Import operation will replace the existing dataset with the new one.
Import operation will fail if there is no conflict or if there are more than one datasets with the same name.

ImportInfo

The information about the import

Name Type Description
connectionType

The import connection type for OneDrive for Business file
filePath
  • string

The OneDrive for Business .xlsx file path to import, can be absolute or relative. .pbix files are not supported.
fileUrl
  • string

The shared access signature (SAS) url of the temporary blob storage, used to import large .pbix files between 1 GB and 10 GB

Report

A Power BI report

Name Type Description
createdBy
  • string

The report owner
createdDateTime
  • string

The report created date time.
datasetId
  • string

The dataset id
description
  • string

The report description
embedUrl
  • string

The report embed url
endorsementDetails

The report endorsement details
id
  • string

The report id
modifiedBy
  • string

The user that modified this report
modifiedDateTime
  • string

The report modified date time.
name
  • string

The report name
reportType enum:
  • PaginatedReport

The report type
sensitivityLabel

The report sensitivity label
webUrl
  • string

The report web url

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID