Freigeben über

Admin - WorkspaceInfo PostWorkspaceInfo

Dienst:
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 datasetSchema oder datasetExpressions auf truefestlegen, müssen Sie die Metadatenüberprüfung vollständig aktivieren, damit Daten zurückgegeben werden. Weitere Informationen finden Sie unter Aktivieren von Mandanteneinstellungen für die Metadatenüberprüfung.

Erlaubnisse

Der Benutzer muss ein Fabric-Administrator sein oder sich mit einem Dienstprinzipal authentifizieren.

Wenn eine App unter der Dienstprinzipalauthentifizierung ausgeführt wird, darf eine App nicht über erforderliche Administratorberechtigungen für Power BI verfügen, die im Azure-Portal darauf festgelegt sind.

Erforderlicher Bereich

Tenant.Read.All oder Tenant.ReadWrite.All

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

Begrenzungen

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

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo
Mit optionalen Parametern: 
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 Mashup-Abfragen) 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. 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. 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. ein Bericht oder ein Dashboard) zurückgegeben werden sollen.
lineage
 query

boolean

Gibt Anlaufinformationen zurück (upstream Dataflows, Kacheln, Datenquellen-IDs)

Anforderungstext

Name Typ Beschreibung
workspaces

string[] (uuid)

Die erforderlichen Arbeitsbereichs-IDs, die gescannt werden sollen (unterstützt 1 bis 100 Arbeitsbereichs-IDs)

Antworten

Name Typ Beschreibung
202 Accepted

ScanRequest

Angenommen

Beispiele

Example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Objekt

Detaillierte Informationen zu einer Power BI-Fehlerantwort

Name Typ Beschreibung
code

string

Der Fehlercode
message

string

Die Fehlermeldung
target

string

Das Fehlerziel

RequiredWorkspaces

Objekt

Eine erforderliche Arbeitsbereichsanforderung

Name Typ Beschreibung
workspaces

string[] (uuid)

Die erforderlichen Arbeitsbereichs-IDs, die gescannt werden sollen (unterstützt 1 bis 100 Arbeitsbereichs-IDs)

ScanRequest

Objekt

Eine Scananforderung

Name Typ Beschreibung
createdDateTime

string (date-time)

Datum und Uhrzeit der Überprüfungserstellung
error

PowerBIApiErrorResponseDetail

Der Scanfehler (falls vorhanden)
id

string (uuid)

Die Scan-ID
status

string

Der Scanstatus