Reports - Clone Report In Group

Clones the specified report from the specified workspace.

If after cloning the report and its dataset reside in two different upgraded workspaces or "My Workspace", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
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/groups/{groupId}/reports/{reportId}/Clone

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace ID

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

PrincipalType

The principal type

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.

ReportUser

A Power BI user access right entry for report

ReportUserAccessRight

Access rights user has for the report (Permission level)

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

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

None principal type, used for whole organization level access.

User
  • string

User principal type

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. Available only for reports created after June 2019.

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

users

The Report User Access Details. This value will be empty. It will be removed from the payload response in an upcoming release. To retrieve user information on an artifact, please consider using the Get Report User as Admin APIs, or the PostWorkspaceInfo API with the getArtifactUser parameter.

webUrl
  • string

The report web url

ReportUser

A Power BI user access right entry for 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

The principal type

reportUserAccessRight

Access rights user has for the report (Permission level)

ReportUserAccessRight

Access rights 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

ReadReshare
  • string

Grants Read and Reshare access to content in report

ReadWrite
  • string

Grants Read and Write access to content in report

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID