Reports - Clone Report

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

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
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions.

POST https://api.powerbi.com/v1.0/myorg/reports/{reportId}/Clone

URI Parameters

Name In Required Type Description
reportId
 path True
  • string
uuid

The report id

Request Body

Name Required Type Description
name True
  • string

The new report name
targetModelId
  • string

Optional parameter for specifying the target associated dataset id.
If not provided, the new report will be associated with the same dataset as the source report
targetWorkspaceId
  • string

Optional parameter for specifying the target workspace id. Empty Guid (00000000-0000-0000-0000-000000000000) indicates 'My Workspace'.
If not provided, the new report will be cloned within the same workspace as the source report.

Responses

Name Type Description
200 OK

OK

Definitions

CloneReportRequest

Power BI clone report request
EndorsementDetails

Power BI endorsement details
Report

A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.
SensitivityLabel

Artifact sensitivity label info

CloneReportRequest

Power BI clone report request

Name Type Description
name
  • string

The new report name
targetModelId
  • string

Optional parameter for specifying the target associated dataset id.
If not provided, the new report will be associated with the same dataset as the source report
targetWorkspaceId
  • string

Optional parameter for specifying the target workspace id. Empty Guid (00000000-0000-0000-0000-000000000000) indicates 'My Workspace'.
If not provided, the new report will be cloned within the same workspace as the source report.

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact
endorsement
  • string

The endorsement status

Report

A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

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