Admin - WorkspaceInfo GetScanResult

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

Gets scan result for the specified scan (should be called only after getting status Succeeded in the scan status API). Scan result will be available for up to 24 hours
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 500 requests per hour.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{scanId}

URI Parameters

Name In Required Type Description
scanId
 path True
  • string
uuid

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

Status code:
200 
{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": false,
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          }
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          }
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          }
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          }
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ]
}

Definitions

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. 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.
Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. 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.
Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. 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.
Datasource

A Power BI datasource
DatasourceConnectionDetails

A Power BI datasource connection details
DatasourceUsage

Datasource usage
DependentDataflow

A Power BI Dependent dataflow
Encryption

Encryption information for a dataset
EncryptionStatus

Dataset encryption status
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
Tile

A Power BI tile
WorkspaceInfo

Workspace info details
WorkspaceInfoResponse

Workspace info response

Dashboard

A Power BI dashboard. Below is a list of properties that may be returned for a dashboard. 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
dataClassification
  • string

The data classification tag of the dashboard
displayName
  • string

The dashboard display name
embedUrl
  • string

The dashboard embed url
id
  • string

The dashboard id
isReadOnly
  • boolean

Is ReadOnly dashboard
sensitivityLabel

The dashboard sensitivity label
tiles

The tiles that belong to the dashboard.

Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. 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
configuredBy
  • string

The dataflow owner
datasourceUsages

Datasource usages
description
  • string

The dataflow description
endorsementDetails

The dataflow endorsement details
modelUrl
  • string

A URL to the dataflow definition file (model.json)
modifiedBy
  • string

The user that modified this dataflow
modifiedDateTime
  • string

modification date time
name
  • string

The dataflow name
objectId
  • string

The dataflow id
sensitivityLabel

The dataflow sensitivity label
upstreamDataflows

Upstream Dataflows

Dataset

A Power BI dataset. Below is a list of properties that may be returned for a dataset. 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
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

Datasource

A Power BI datasource

Name Type Description
connectionDetails

The datasource connection details
connectionString
  • string

(Deprecated) The datasource connection string. Available only for DirectQuery.
datasourceId
  • string

The bound datasource id. Empty when not bound to a gateway.
datasourceType
  • string

The datasource type
gatewayId
  • string

The bound gateway id. Empty when not bound to a gateway.
name
  • string

(Deprecated) The datasource name. Available only for DirectQuery.

DatasourceConnectionDetails

A Power BI datasource connection details

Name Type Description
database
  • string

The connection database.
server
  • string

The connection server.
url
  • string

The connection 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

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

Tile

A Power BI tile

Name Type Description
colSpan
  • integer

number of columns a tile should span
datasetId
  • string

The dataset id. Available only for tiles created from a report or using a dataset; for example, Q&A tiles.
embedData
  • string

The tile embed data
embedUrl
  • string

The tile embed url
id
  • string

The tile id
reportId
  • string

The report id. Available only for tiles created from a report.
rowSpan
  • integer

number of rows a tile should span
title
  • string

The dashboard display name

WorkspaceInfo

Workspace info details

Name Type Description
capacityId
  • string

The workspace capacity ID
dashboards

The dashboards associated with this workspace. The list of properties returned varies between APIs, thus you may not see them all as part of the API response.
dataRetrievalState
  • string

The workspace data retrieval state
dataflows

The dataflows associated with this workspace. The list of properties returned varies between APIs, thus you may not see them all as part of the API response.
datasets

The datasets associated with this workspace. The list of properties returned varies between APIs, thus you may not see them all as part of the API response.
description
  • string

The workspace description
id
  • string

The workspace object ID
isOnDedicatedCapacity
  • boolean

Whether the workspace is on dedicated capacity
name
  • string

The workspace name
reports

The reports associated with this workspace. The list of properties returned varies between APIs, thus you may not see them all as part of the API response.
state
  • string

The workspace state
type
  • string

The workspace type

WorkspaceInfoResponse

Workspace info response

Name Type Description
datasourceInstances

The datasources' instances associated with this scan
workspaces

The workspace info associated with this scan