Admin - WorkspaceInfo GetScanResult
Gets the scan result for the specified scan.
Only make this API call after a successful GetScanStatus API call. The scan result will remain available for 24 hours.
Permissions
The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
When running under service principal authentication, an app must not have any admin-consent required permissions for Power BI set on it in the Azure portal.
Required Scope
Tenant.Read.All or Tenant.ReadWrite.All
Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.
Limitations
Maximum 500 requests per hour.
GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{scanId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
scan
|
path | True |
|
The scan ID, which is included in the response from the workspaces or the Admin - WorkspaceInfo PostWorkspaceInfo API call that triggered the scan. |
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
{
"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"
},
"users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"appUserAccessRight": "ReadExplore",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User"
}
]
}
],
"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"
},
"users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"appUserAccessRight": "ReadExplore",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User"
}
]
}
],
"datasets": [
{
"id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
"name": "ExportB",
"tables": [
{
"name": "DW_Revenues",
"columns": [
{
"name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
"dataType": "Int64",
"isHidden": true
}
],
"measures": [
{
"name": "MyMeasure",
"expression": "CALCULATE(SELECTEDVALUE('DW_Revenues DW_RevenuesTestToBeDeleted'[Numbers])*10)",
"description": "My measure",
"isHidden": false
}
],
"isHidden": false,
"description": "My table",
"source": [
{
"expression": "let\n Source = Revenues,\n Param = RevenuesParam\nin\n Source"
}
]
}
],
"relationships": [],
"configuredBy": "john@contoso.com",
"targetStorageMode": "Abf",
"endorsementDetails": {
"endorsement": "Certified",
"certifiedBy": "john@contoso.com"
},
"expressions": [
{
"name": "Revenues",
"description": "revenues",
"expression": "let\n Source = Sql.Database(\"sqlserver.database.windows.net\", \"DB\"),\n RevenuesTable = Source{[Schema=\"DB_SCHEMA\",Item=\"DB_SCHEMA_ITEM\"]}[Data]\nin\n RevenuesTable"
},
{
"name": "RevenuesParam",
"description": "revenues param",
"expression": "\"revenues param value\" meta [IsParameterQuery=true, Type=\"Text\", IsParameterQueryRequired=true]"
}
],
"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"
}
],
"misconfiguredDatasourceUsages": [
{
"datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
}
],
"sensitivityLabel": {
"labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
},
"users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"appUserAccessRight": "ReadExplore",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User"
}
]
}
],
"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"
}
],
"misconfiguredDatasourceUsages": [
{
"datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
}
],
"sensitivityLabel": {
"labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
},
"users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"appUserAccessRight": "ReadExplore",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User"
}
]
}
],
"datamarts": [
{
"id": "9df8d63c-db5b-44c3-a8e3-9f8c8ec1eec2",
"name": "MyDatamart",
"description": "SQL datamart",
"type": "Sql",
"configuredBy": "john@contoso.com",
"configuredById": "5c9f8c24-2a94-4fd2-a105-9a8b096cdsew",
"modifiedBy": "john@contoso.com",
"modifiedDateTime": "2020-06-16T08:27:47.783Z",
"sensitivityLabel": {
"labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
},
"endorsementDetails": {
"endorsement": "Certified",
"certifiedBy": "john@contoso.com"
},
"UpstreamDataflows": [
{
"targetDataflowId": "5c9f8c24-2a94-34fd-a105-9a8b096c4555",
"groupId": "5c9f8c24-4dsc-4fd2-a105-9a8b096c4fgt"
}
],
"datasourceUsages": [
{
"datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
}
],
"Users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User",
"userType": "User",
"profile": {
"id": "45416453",
"displayName": "John's profile"
},
"datamartUserAccessRight": "Read"
}
]
}
],
"users": [
{
"displayName": "John Nick",
"emailAddress": "john@contoso.com",
"appUserAccessRight": "ReadExplore",
"identifier": "john@contoso.com",
"graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
"principalType": "User"
}
]
}
],
"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"
}
],
"misconfiguredDatasourceInstances": [
{
"datasourceType": "Sql",
"connectionDetails": {
"server": "sqlserver.database.windows.net",
"database": "dbo.table"
},
"datasourceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab",
"gatewayId": "505a19c1-4190-4e8e-a4f6-dd72722feced"
}
]
}
Definitions
ASMashup |
A dataset table source |
Column |
A dataset column |
Dashboard |
A Power BI user access right entry for a dashboard |
Dashboard |
The access right that the user has for the dashboard (permission level) |
Dataflow |
A Power BI user access right entry for a dataflow |
Dataflow |
The access right that a user has for the dataflow (permission level) |
datamart |
The datamart current state |
datamart |
The datamart status |
datamart |
The datamart type |
Datamart |
A Power BI user access right entry for a report |
Datamart |
The access right that the user has for the datamart (permission level) |
Dataset |
A Power BI user access right entry for a dataset |
Dataset |
The access right that the user has for the dataset (permission level) |
Datasource |
A Power BI data source |
Datasource |
The Power BI data source connection details. See examples in Get Datasources or Get Datasources In Group. |
Datasource |
Data source usage |
Dependent |
A Power BI dependent dataflow |
Dependent |
A Power BI dependent datamart |
Dependent |
A Power BI dependent dataset |
Endorsement |
Power BI endorsement details |
Expression |
A dataset expression |
Group |
A Power BI user with access to the workspace |
Group |
The access right (permission level) that a user has on the workspace |
Measure |
A Power BI measure |
Principal |
The principal type |
Report |
A Power BI user access right entry for a report |
Report |
The access right that the user has for the report (permission level) |
Row |
A data row in a dataset |
Sensitivity |
Sensitivity label info for a Power BI item (such as a report or a dashboard) |
Service |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
Table |
A dataset table |
Workspace |
Workspace info details |
Workspace |
A Power BI dashboard returned by WorkspaceInfo APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database. |
Workspace |
The metadata of a dataflow returned by Workspace Info APIs. 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. |
Workspace |
A Power BI datamart returned by Workspace Info APIs. The API returns a subset of the following list of datamart properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database. |
Workspace |
A Power BI dataset returned by WorkspaceInfo APIs. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database. |
Workspace |
A Power BI report returned by Workspace Info APIs. 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. |
Workspace |
Workspace info response |
Workspace |
A Power BI tile returned by WorkspaceInfo APIs |
ASMashupExpression
A dataset table source
Name | Type | Description |
---|---|---|
expression |
|
The source expression |
Column
A dataset column
Name | Type | Description |
---|---|---|
dataCategory |
|
Optional. The string value to be used for the data category which describes the data within this column. |
dataType |
|
The column data type |
formatString |
|
Optional. The format of the column as specified in FORMAT_STRING. |
isHidden |
|
Optional. Whether the column is hidden. The default is |
name |
|
The column name |
sortByColumn |
|
Optional. String name of a column in the same table to be used to order the current column. |
summarizeBy |
|
Optional. The aggregate function to use for summarizing this column. |
DashboardUser
A Power BI user access right entry for a dashboard
Name | Type | Description |
---|---|---|
dashboardUserAccessRight |
The access right that the user has for the dashboard (permission level) |
|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
userType |
|
Type of the user. |
DashboardUserAccessRight
The access right that the user has for the dashboard (permission level)
Name | Type | Description |
---|---|---|
None |
|
No permission to content in dashboard |
Owner |
|
Grants Read, Write and Reshare access to content in report |
Read |
|
Grants Read access to content in dashboard |
ReadCopy |
|
Grants Read and Copy access to content in dashboard |
ReadReshare |
|
Grants Read and Reshare access to content in dashboard |
ReadWrite |
|
Grants Read and Write access to content in dashboard |
DataflowUser
A Power BI user access right entry for a dataflow
Name | Type | Description |
---|---|---|
DataflowUserAccessRight |
The access right that a user has for the dataflow (permission level) |
|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
userType |
|
Type of the user. |
DataflowUserAccessRight
The access right that a user has for the dataflow (permission level)
Name | Type | Description |
---|---|---|
None |
|
Removes permission to content in dataflow |
Owner |
|
Grants Read, Write and Reshare access to content in dataflow |
Read |
|
Grants Read access to content in dataflow |
ReadReshare |
|
Grants Read and Reshare access to content in dataflow |
ReadWrite |
|
Grants Read and Write access to content in dataflow |
datamartState
The datamart current state
Name | Type | Description |
---|---|---|
Active |
|
The datamart is active |
Deleted |
|
The datamart was deleted |
Evicted |
|
The datamart was evicted |
Initialized |
|
The datamart was initialized |
Invalid |
|
The datamart has invalid state |
Migrating |
|
The datamart is migrating |
datamartStatus
The datamart status
Name | Type | Description |
---|---|---|
Available |
|
The datamart is available |
Error |
|
The datamart has error status |
InProgress |
|
The datamart is in progress |
Invalid |
|
The datamart has invalid status |
NoCapacity |
|
The datamart has no capacity |
OutOfRegion |
|
The datamart is out of region |
SuspendedInCriticalPhase |
|
The datamart is suspended in critical phase |
datamartType
The datamart type
Name | Type | Description |
---|---|---|
Dataverse |
|
The datamart is of Dataverse type |
Datawarehouse |
|
The datamart is of Datawarehouse type |
Ignore |
|
The datamart has no type |
Lakehouse |
|
The datamart is of Lakehouse type |
Sql |
|
The datamart is of Sql type |
Unset |
|
The datamart type was unset |
DatamartUser
A Power BI user access right entry for a report
Name | Type | Description |
---|---|---|
datamartUserAccessRight |
The access right that the user has for the datamart (permission level) |
|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
userType |
|
Type of the user. |
DatamartUserAccessRight
The access right that the user has for the datamart (permission level)
Name | Type | Description |
---|---|---|
Explore |
|
Grants explore access to content in datamart |
None |
|
No permission to content in datamart |
Read |
|
Grants Read access to content in datamart |
ReadExplore |
|
Grants read and explore access to content in datamart |
ReadReshare |
|
Grants read and reshare access to content in datamart |
ReadReshareExplore |
|
Grants read and reshare and explore access to content in datamart |
ReadWrite |
|
Grants read and write access to content in datamart |
ReadWriteExplore |
|
Grants read and write and explore access to content in datamart |
ReadWriteReshare |
|
Grants read and write and reshare access to content in datamart |
ReadWriteReshareExplore |
|
Grants read and write and reshare and explore access to content in datamart |
Reshare |
|
Grants reshare access to content in datamart |
Write |
|
Grants write access to content in datamart |
DatasetUser
A Power BI user access right entry for a dataset
Name | Type | Description |
---|---|---|
datasetUserAccessRight |
The access right that the user has for the dataset (permission level) |
|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
userType |
|
Type of the user. |
DatasetUserAccessRight
The access right that the user has for the dataset (permission level)
Name | Type | Description |
---|---|---|
None |
|
Removes permission to the content in the dataset |
Read |
|
Grants Read access to the content in the dataset |
ReadExplore |
|
Grants Read and Explore access to the content in the dataset |
ReadReshare |
|
Grants Read and Reshare access to the content in the dataset |
ReadReshareExplore |
|
Grants Read, Reshare, and Explore access to the content in the dataset |
ReadWrite |
|
Grants Read and Write access to the content in the dataset |
ReadWriteExplore |
|
Grants Read, Write, and Explore access to the content in the dataset |
ReadWriteReshare |
|
Grants Read, Write, and Reshare access to the content in the dataset |
ReadWriteReshareExplore |
|
Grants Read, Write, Reshare, and Explore access to the content in the dataset |
Datasource
A Power BI data source
Name | Type | Description |
---|---|---|
connectionDetails |
The data source connection details |
|
connectionString |
|
(Deprecated) The data source connection string. Available only for DirectQuery. |
datasourceId |
|
The bound data source ID, which is empty when not bound to a gateway |
datasourceType |
|
The data source type |
gatewayId |
|
The bound gateway ID, which is empty when not bound to a gateway. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster and is similar to the gateway cluster ID. |
name |
|
(Deprecated) The data source name. Available only for DirectQuery. |
DatasourceConnectionDetails
The Power BI data source connection details. See examples in Get Datasources or Get Datasources In Group.
Name | Type | Description |
---|---|---|
account |
|
The connection account |
classInfo |
|
The connection class information |
database |
|
The connection database |
domain |
|
The connection domain |
emailAddress |
|
The connection email address |
kind |
|
The connection kind |
loginServer |
|
The connection login server |
path |
|
The connection path |
server |
|
The connection server |
url |
|
The connection URL |
DatasourceUsage
Data source usage
Name | Type | Description |
---|---|---|
datasourceInstanceId |
|
The data source instance ID |
DependentDataflow
A Power BI dependent dataflow
Name | Type | Description |
---|---|---|
groupId |
|
The target group ID |
targetDataflowId |
|
The target dataflow ID |
DependentDatamart
A Power BI dependent datamart
Name | Type | Description |
---|---|---|
groupId |
|
The target group ID |
targetDatamartId |
|
The target datamart ID |
DependentDataset
A Power BI dependent dataset
Name | Type | Description |
---|---|---|
groupId |
|
The target group ID |
targetDatasetId |
|
The target dataset ID |
EndorsementDetails
Power BI endorsement details
Name | Type | Description |
---|---|---|
certifiedBy |
|
The user that certified the Power BI item (such as a report or a dashboard) |
endorsement |
|
The endorsement status |
Expression
A dataset expression
Name | Type | Description |
---|---|---|
description |
|
The expression description |
expression |
A dataset table source |
|
name |
|
The expression name |
GroupUser
A Power BI user with access to the workspace
Name | Type | Description |
---|---|---|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
groupUserAccessRight |
The access right (permission level) that a user has on the workspace |
|
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
userType |
|
Type of the user. |
GroupUserAccessRight
The access right (permission level) that a user has on the workspace
Name | Type | Description |
---|---|---|
Admin |
|
Administrator rights to workspace content |
Contributor |
|
Read and explore (ReadExplore) access to workspace content |
Member |
|
Read, reshare and explore (ReadReshareExplore) access rights to workspace content |
None |
|
No access to workspace content |
Viewer |
|
Read-only (Read) access to workspace content |
Measure
A Power BI measure
Name | Type | Description |
---|---|---|
description |
|
Optional. The measure description. |
expression |
|
A valid DAX expression |
formatString |
|
Optional. A string describing how the value should be formatted when it's displayed as specified in FORMAT_STRING. |
isHidden |
|
Optional. Whether the measure is hidden. |
name |
|
The measure name |
PrincipalType
The principal type
Name | Type | Description |
---|---|---|
App |
|
Service principal type |
Group |
|
Group principal type |
None |
|
No principal type. Use for whole organization level access. |
User |
|
User principal type |
ReportUser
A Power BI user access right entry for a report
Name | Type | Description |
---|---|---|
displayName |
|
Display name of the principal |
emailAddress |
|
Email address of the user |
graphId |
|
Identifier of the principal in Microsoft Graph. Only available for admin APIs. |
identifier |
|
Identifier of the principal |
principalType |
The principal type |
|
profile |
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution. |
|
reportUserAccessRight |
The access right that the user has for the report (permission level) |
|
userType |
|
Type of the user. |
ReportUserAccessRight
The access right that the user has for the report (permission level)
Name | Type | Description |
---|---|---|
None |
|
No permission to content in report |
Owner |
|
Grants Read, Write and Reshare access to content in report |
Read |
|
Grants Read access to content in report |
ReadCopy |
|
Grants Read and Copy access to content in report |
ReadReshare |
|
Grants Read and Reshare access to content in report |
ReadWrite |
|
Grants Read and Write access to content in report |
Row
A data row in a dataset
Name | Type | Description |
---|---|---|
id |
|
The unique row ID |
SensitivityLabel
Sensitivity label info for a Power BI item (such as a report or a dashboard)
Name | Type | Description |
---|---|---|
labelId |
|
The sensitivity label ID |
ServicePrincipalProfile
A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.
Name | Type | Description |
---|---|---|
displayName |
|
The service principal profile name |
id |
|
The service principal profile ID |
Table
A dataset table
Name | Type | Description |
---|---|---|
columns |
|
The column schema for this table |
description |
|
The table description |
isHidden |
|
Optional. Whether this dataset table is hidden. |
measures |
|
The measures within this table |
name |
|
The table name |
rows |
|
The data rows within this table |
source |
The table source |
WorkspaceInfo
Workspace info details
Name | Type | Description |
---|---|---|
capacityId |
|
The workspace capacity ID |
dashboards |
The dashboards associated with this workspace. The list of dashboard properties returned varies for different API calls, so you might not see all dashboard properties in an API response. |
|
dataRetrievalState |
|
The workspace data retrieval state |
dataflows |
The dataflows associated with this workspace. The list of dataflow properties returned varies for different API calls, so you might not see all dataflow properties in an API response. |
|
datamarts |
The datamarts associated with this workspace. The list of datamart properties returned varies for different API calls, so you might not see all datamart properties in an API response. |
|
datasets |
The datasets associated with this workspace. The list of dataset properties returned varies for different API calls, so you might not see all dataset properties in an API response. |
|
description |
|
The workspace description |
id |
|
The workspace object ID |
isOnDedicatedCapacity |
|
Whether the workspace is assigned to a dedicated capacity |
name |
|
The workspace name |
reports |
The reports associated with this workspace. The list of report properties returned varies for different API calls, so you might not see all report properties in an API response. |
|
state |
|
The workspace state |
type |
|
The workspace type |
users |
The users with access to the workspace. The list is returned only when explicitly requested. To retrieve a list of users for a classic workspace, use the Azure Active Directory Graph API. |
WorkspaceInfoDashboard
A Power BI dashboard returned by WorkspaceInfo APIs. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.
Name | Type | Description |
---|---|---|
appId |
|
The app ID, returned only if the dashboard belongs to an app |
dataClassification |
|
The data classification tag of a Power BI item (such as a report or a dashboard) |
displayName |
|
The display name of the dashboard |
id |
|
The dashboard ID |
isReadOnly |
|
Whether the dashboard is read-only |
sensitivityLabel |
The sensitivity label |
|
tiles |
The tiles that belong to the dashboard |
|
users |
(Empty value) The dashboard user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dashboard by using the Get Dashboard Users as Admin API call, or the PostWorkspaceInfo API call with the |
WorkspaceInfoDataflow
The metadata of a dataflow returned by Workspace Info APIs. 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 |
|
The dataflow owner |
datasourceUsages |
The data source usages |
|
description |
|
The dataflow description |
endorsementDetails |
The endorsement details |
|
misconfiguredDatasourceUsages |
The data source misconfigured usages |
|
modelUrl |
|
A URL to the dataflow definition file (model.json) |
modifiedBy |
|
The user that modified the dataflow |
modifiedDateTime |
|
The date and time that the dataflow was last modified |
name |
|
The dataflow name |
objectId |
|
The dataflow ID |
sensitivityLabel |
The sensitivity label |
|
upstreamDataflows |
The list of all the dataflows this item depends on |
|
upstreamDatamarts |
The list of all the datamarts this item depends on |
|
users |
(Empty value) The dataflow user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI dataflow by using the Get Dataflow Users as Admin API call, or the PostWorkspaceInfo API call with the |
WorkspaceInfoDatamart
A Power BI datamart returned by Workspace Info APIs. The API returns a subset of the following list of datamart properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.
Name | Type | Description |
---|---|---|
configuredBy |
|
The name of the datamart owner |
configuredById |
|
The ID of the datamart owner |
datasourceUsages |
The data source usages |
|
description |
|
The datamart description |
endorsementDetails |
The datamart endorsement details |
|
id |
|
The datamart ID |
modifiedBy |
|
The last user that modified the datamart |
modifiedById |
|
The ID of the last user that modified the datamart |
modifiedDateTime |
|
The date and time that the datamart was last modified |
name |
|
The datamart name |
sensitivityLabel |
The datamart sensitivity label |
|
state |
The datamart current state |
|
status |
The datamart status |
|
suspendedBatchId |
|
datamart suspended batch id |
type |
The datamart type |
|
upstreamDataflows |
The list of all the dataflows this item depends on |
|
upstreamDatamarts |
The list of all the datamarts this item depends on |
|
users |
The user access details for a Power BI datamart. |
WorkspaceInfoDataset
A Power BI dataset returned by WorkspaceInfo APIs. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.
Name | Type | Description |
---|---|---|
ContentProviderType |
|
The content provider type for the dataset |
CreatedDate |
|
The dataset creation date and time |
configuredBy |
|
The dataset owner |
datasourceUsages |
The data source usages |
|
description |
|
The dataset description |
endorsementDetails |
The endorsement details |
|
expressions |
The dataset expressions |
|
id |
|
The dataset ID |
misconfiguredDatasourceUsages |
The data source misconfigured usages |
|
name |
|
The dataset name |
schemaMayNotBeUpToDate |
|
Whether the dataset schema might not be up to date |
schemaRetrievalError |
|
The dataset schema retrieval error |
sensitivityLabel |
The sensitivity label |
|
tables |
|
The dataset tables |
targetStorageMode |
|
The dataset storage mode |
upstreamDataflows |
The list of all the dataflows this item depends on |
|
upstreamDatamarts |
The list of all the datamarts this item depends on |
|
upstreamDatasets |
The upstream datasets |
|
users |
(Empty value) The dataset user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dataset Users as Admin API, or the PostWorkspaceInfo API with the |
WorkspaceInfoReport
A Power BI report returned by Workspace Info APIs. 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 |
|
The app ID, returned only if the report belongs to an app |
createdBy |
|
The report owner. Available only for reports created after June 2019. |
createdById |
|
The ID of the report owner. Available only for reports created after June 2019. |
createdDateTime |
|
The report creation date and time |
datasetId |
|
The dataset ID of the report |
datasetWorkspaceId |
|
The workspace ID of the related dataset, returned only if the related dataset belongs to a different workspace |
description |
|
The report description |
endorsementDetails |
The endorsement details |
|
id |
|
The report ID |
modifiedBy |
|
The last user that modified the report |
modifiedById |
|
The ID of the last user that modified the report |
modifiedDateTime |
|
The date and time that the report was last modified |
name |
|
The name of the report |
reportType |
enum:
|
The report type |
sensitivityLabel |
The sensitivity label |
|
users |
(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 |
WorkspaceInfoResponse
Workspace info response
Name | Type | Description |
---|---|---|
datasourceInstances |
The data source instances associated with this scan |
|
misconfiguredDatasourceInstances |
The data source misconfigured instances associated with this scan |
|
workspaces |
The workspace info associated with this scan |
WorkspaceInfoTile
A Power BI tile returned by WorkspaceInfo APIs
Name | Type | Description |
---|---|---|
datasetId |
|
The dataset ID. Available only for tiles created from a report or by using a dataset, such as Q&A tiles. |
datasetWorkspaceId |
|
The workspace ID of the related dataset, returned only if the related dataset belongs to a different workspace |
id |
|
The tile ID |
reportId |
|
The report ID. Available only for tiles created from a report. |
title |
|
The display name of the tile |