Reports - Clone Report

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Clones the specified report from My workspace.

If the dataset for a cloned report resides in two different workspaces or in My workspace, then a shared dataset will be created in the report's workspace.
When cloned, reports with a live connection will lose that connection and instead have a direct binding to the target dataset.

Permissions

The user must have all of the following, unless a requirement doesn't apply:

Write permission on the specified report.
Build permission on the target dataset, required if the targetModelId parameter is used.

Required Scope

Content.Create

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. An empty GUID (`00000000-0000-0000-0000-000000000000`) indicates My workspace. If this parameter isn't provided, the new report will be cloned within the same workspace as the source report.

Responses

Name	Type	Description
200 OK	Report	OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/reports/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Clone

Request Body

{
  "name": "New Report Name",
  "targetModelId": "8e4d5880-81d6-4804-ab97-054665050799",
  "targetWorkspaceId": "2f42a406-a075-4a15-bbf2-97ef958c94cb"
}

Sample response

Status code:: 200

Definitions

Name	Description
CloneReportRequest	Power BI clone report request
PrincipalType	The principal type
Report	A Power BI report. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.
ReportUser	A Power BI user access right entry for a report
ReportUserAccessRight	The access right that the user has for the report (permission level)
ServicePrincipalProfile	A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
Subscription	An email subscription for a Power BI item (such as a report or a dashboard)
SubscriptionUser	A Power BI email subscription user

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. An empty GUID (`00000000-0000-0000-0000-000000000000`) indicates My workspace. If this parameter isn't provided, the new report will be cloned within the same workspace as the source report.

PrincipalType

The principal type

Name	Type	Description
App	string	Service principal type
Group	string	Group principal type
None	string	No principal type. Use for whole organization level access.
User	string	User principal type

Report

A Power BI report. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name	Type	Description
appId	string	The app ID, returned only if the report belongs to an app
datasetId	string	The dataset ID of the report
description	string	The report description
embedUrl	string	The embed URL of the report
id	string	The report ID
isOwnedByMe	boolean	Determine if the report is created by the current user.
name	string	The name of the report
originalReportId	string	The actual report ID when the workspace is published as an app.
reportType	enum: PaginatedReport PowerBIReport	The report type
subscriptions	Subscription[]	(Empty Value) The subscription details for a Power BI item (such as a report or a dashboard). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information for a Power BI report by using the Get Report Subscriptions as Admin API call.
users	ReportUser[]	(Empty value) The user access details for a Power BI report. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI report by using the Get Report Users as Admin API call, or the PostWorkspaceInfo API call with the `getArtifactUsers` parameter.
webUrl	string	The web URL of the report

ReportUser

A Power BI user access right entry for a report

Name	Type	Description
displayName	string	Display name of the principal
emailAddress	string	Email address of the user
graphId	string	Identifier of the principal in Microsoft Graph. Only available for admin APIs.
identifier	string	Identifier of the principal
principalType	PrincipalType	The principal type
profile	ServicePrincipalProfile	A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
reportUserAccessRight	ReportUserAccessRight	The access right that the user has for the report (permission level)
userType	string	Type of the user.

ReportUserAccessRight

The access right that the user has for the report (permission level)

Name	Type	Description
None	string	No permission to content in report
Owner	string	Grants Read, Write and Reshare access to content in report
Read	string	Grants Read access to content in report
ReadCopy	string	Grants Read and Copy access to content in report
ReadReshare	string	Grants Read and Reshare access to content in report
ReadWrite	string	Grants Read and Write access to content in report

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name	Type	Description
displayName	string	The service principal profile name
id	string	The service principal profile ID

Subscription

An email subscription for a Power BI item (such as a report or a dashboard)

Name	Type	Description
artifactDisplayName	string	The name of the subscribed Power BI item (such as a report or a dashboard)
artifactId	string	The ID of the subscribed Power BI item (such as a report or a dashboard)
artifactType	string	The type of Power BI item (for example a `Report`, `Dashboard`, or `Dataset`)
attachmentFormat	string	Format of the report attached in the email subscription
endDate	string	The end date and time of the email subscription
frequency	string	The frequency of the email subscription
id	string	The subscription ID
isEnabled	boolean	Whether the email subscription is enabled
linkToContent	boolean	Whether a subscription link exists in the email subscription
previewImage	boolean	Whether a screenshot of the report exists in the email subscription
startDate	string	The start date and time of the email subscription
subArtifactDisplayName	string	The page name of the subscribed Power BI item, if it's a report.
title	string	The app name
users	SubscriptionUser[]	The details of each email subscriber. When using the Get User Subscriptions As Admin API call, the returned value is an empty array (null). This property will be removed from the payload response in an upcoming release. You can retrieve subscription information on a Power BI report or dashboard by using the Get Report Subscriptions As Admin or Get Dashboard Subscriptions As Admin API calls.

SubscriptionUser

A Power BI email subscription user

Name	Type	Description
displayName	string	Display name of the principal
emailAddress	string	Email address of the user
graphId	string	Identifier of the principal in Microsoft Graph. Only available for admin APIs.
identifier	string	Identifier of the principal
principalType	PrincipalType	The principal type
profile	ServicePrincipalProfile	A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
userType	string	Type of the user.

Del via