Admin - WorkspaceInfo PostWorkspaceInfo

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

Initiiert einen Aufruf zum Empfangen von Metadaten für die angeforderte Liste der Arbeitsbereiche.

Wichtig

Wenn Sie die Parameter oder datasetExpressions auf truefestlegen, müssen Sie die datasetSchema Metadatenüberprüfung vollständig aktivieren, damit Daten zurückgegeben werden können. Weitere Informationen finden Sie unter Aktivieren von Mandanteneinstellungen für die Metadatenüberprüfung.

Berechtigungen

Der Benutzer muss über Administratorrechte (z. B. Microsoft globalen Administrator 365 oder Power BI-Dienstadministrator) verfügen oder sich mithilfe eines Dienstprinzipals authentifizieren.

Bei der Ausführung unter Der Dienstprinzipalauthentifizierung darf eine App keine erforderlichen Berechtigungen für Die Administratoreinwilligung für Power BI im Azure-Portal festgelegt haben.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

Nur bei der Authentifizierung über ein standardmäßiges delegiertes Administratorzugriffstoken relevant. Darf nicht vorhanden sein, wenn die Authentifizierung über einen Dienstprinzipal verwendet wird.

Einschränkungen

  • Maximal 500 Anforderungen pro Stunde.
  • Maximal 16 gleichzeitige Anforderungen. 

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}&datasetSchema={datasetSchema}&datasetExpressions={datasetExpressions}&getArtifactUsers={getArtifactUsers}

URI-Parameter

Name In Erforderlich Typ Beschreibung
datasetExpressions
 query

boolean

Gibt an, ob Datasetausdrücke (DAX- und Mashupabfragen) zurückgegeben werden sollen. Wenn Sie diesen Parameter auf truefestlegen, müssen Sie die Metadatenüberprüfung vollständig aktivieren, damit Daten zurückgegeben werden können. Weitere Informationen finden Sie unter Aktivieren von Mandanteneinstellungen für die Metadatenüberprüfung.
datasetSchema
 query

boolean

Gibt an, ob das Datasetschema (Tabellen, Spalten und Measures) zurückgegeben werden soll. Wenn Sie diesen Parameter auf truefestlegen, müssen Sie die Metadatenüberprüfung vollständig aktivieren, damit Daten zurückgegeben werden können. Weitere Informationen finden Sie unter Aktivieren von Mandanteneinstellungen für die Metadatenüberprüfung.
datasourceDetails
 query

boolean

Gibt an, ob Datenquellendetails zurückgegeben werden sollen
getArtifactUsers
 query

boolean

Gibt an, ob Benutzerdetails für ein Power BI-Element (z. B. einen Bericht oder ein Dashboard) zurückgegeben werden sollen
lineage
 query

boolean

Gibt an, ob Herkunftsinformationen (Upstream-Dataflows, Kacheln, Datenquellen-IDs) zurückgegeben werden sollen

Anforderungstext

Name Typ Beschreibung
workspaces

string[]

Die zu scannenden Arbeitsbereichs-IDs (unterstützt 1 bis 100 Arbeitsbereichs-IDs)

Antworten

Name Typ Beschreibung
202 Accepted

ScanRequest

Zulässig

Beispiele

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True&datasetSchema=True&datasetExpressions=True
Request Body
{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:
202 
{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

Definitionen

Name Beschreibung
PowerBIApiErrorResponseDetail

Detaillierte Informationen zu einer Power BI-Fehlerantwort
RequiredWorkspaces

Eine erforderliche Arbeitsbereichsanforderung
ScanRequest

Eine Scananforderung

PowerBIApiErrorResponseDetail

Detaillierte Informationen zu einer Power BI-Fehlerantwort

Name Typ Beschreibung
code

string

Den Fehlercode
message

string

Die Fehlermeldung
target

string

Das Fehlerziel

RequiredWorkspaces

Eine erforderliche Arbeitsbereichsanforderung

Name Typ Beschreibung
workspaces

string[]

Die zu scannenden Arbeitsbereichs-IDs (unterstützt 1 bis 100 Arbeitsbereichs-IDs)

ScanRequest

Eine Scananforderung

Name Typ Beschreibung
createdDateTime

string

Datum und Uhrzeit der Überprüfungserstellung
error

PowerBIApiErrorResponseDetail

Der Überprüfungsfehler (falls vorhanden)
id

string

Die Scan-ID
status

string

Der Scanstatus