Admin - WorkspaceInfo PostWorkspaceInfo
Initiates a call to receive metadata for the requested list of workspaces.
Important
If you set the datasetSchema
or datasetExpressions
parameters to true
, you must fully enable metadata scanning in order for data to be returned. For more information, see Enable tenant settings for metadata scanning.
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.
- Maximum 16 simultaneous requests.
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
dataset
|
query |
|
Whether to return dataset expressions (DAX and Mashup queries). If you set this parameter to |
|
dataset
|
query |
|
Whether to return dataset schema (tables, columns and measures). If you set this parameter to |
|
datasource
|
query |
|
Whether to return data source details |
|
get
|
query |
|
Whether to return user details for a Power BI item (such as a report or a dashboard) |
|
lineage
|
query |
|
Whether to return lineage info (upstream dataflows, tiles, data source IDs) |
Request Body
Name | Type | Description |
---|---|---|
workspaces |
|
The required workspace IDs to be scanned (supports 1 to 100 workspace IDs) |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
Accepted |
Examples
Example
Sample Request
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True
{
"workspaces": [
"97d03602-4873-4760-b37e-1563ef5358e3",
"67b7e93a-3fb3-493c-9e41-2c5051008f24"
]
}
Sample Response
{
"id": "e7d03602-4873-4760-b37e-1563ef5358e3",
"createdDateTime": "2020-06-15T16:46:28.0487687Z",
"status": "NotStarted"
}
Definitions
Power |
Detailed information about a Power BI error response |
Required |
A required workspaces request |
Scan |
A scan request |
PowerBIApiErrorResponseDetail
Detailed information about a Power BI error response
Name | Type | Description |
---|---|---|
code |
|
The error code |
message |
|
The error message |
target |
|
The error target |
RequiredWorkspaces
A required workspaces request
Name | Type | Description |
---|---|---|
workspaces |
|
The required workspace IDs to be scanned (supports 1 to 100 workspace IDs) |
ScanRequest
A scan request
Name | Type | Description |
---|---|---|
createdDateTime |
|
The scan creation date and time |
error |
The scan error (if any) |
|
id |
|
The scan ID |
status |
|
The scan state |