Admin - WorkspaceInfo PostWorkspaceInfo

Odwołanie

Service:: Power BI REST APIs

API Version:: v1.0

Inicjuje wywołanie w celu odbierania metadanych dla żądanej listy obszarów roboczych.

Ważne

Jeśli ustawisz parametr or datasetExpressions na datasetSchematrue, musisz w pełni włączyć skanowanie metadanych w celu zwrócenia danych. Aby uzyskać więcej informacji, zobacz Włączanie ustawień dzierżawy na potrzeby skanowania metadanych.

Uprawnienia

Użytkownik musi mieć uprawnienia administratora (takie jak administrator globalny Microsoft 365 lub administrator usługi Power BI) lub uwierzytelnić się przy użyciu jednostki usługi.

W przypadku uruchamiania w ramach uwierzytelniania jednostki usługi aplikacja nie może mieć żadnych uprawnień wymaganych przez administratora dla usługi Power BI ustawionej w Azure Portal.

Wymagany zakres

Tenant.Read.All lub Tenant.ReadWrite.All

Istotne tylko w przypadku uwierzytelniania za pośrednictwem standardowego tokenu dostępu administratora delegowanego. Nie może być obecny w przypadku użycia uwierzytelniania za pośrednictwem jednostki usługi.

Ograniczenia

Maksymalnie 500 żądań na godzinę.
Maksymalnie 16 jednoczesnych żądań.

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}

Parametry identyfikatora URI

Nazwa	W	Typ	Opis
datasetExpressions	query	boolean	Czy zwracać wyrażenia zestawu danych (zapytania języka DAX i Mashup). Jeśli ustawisz ten parametr na `true`wartość , musisz w pełni włączyć skanowanie metadanych w celu zwrócenia danych. Aby uzyskać więcej informacji, zobacz Włączanie ustawień dzierżawy na potrzeby skanowania metadanych.
datasetSchema	query	boolean	Czy zwracać schemat zestawu danych (tabele, kolumny i miary). Jeśli ustawisz ten parametr na `true`wartość , musisz w pełni włączyć skanowanie metadanych w celu zwrócenia danych. Aby uzyskać więcej informacji, zobacz Włączanie ustawień dzierżawy na potrzeby skanowania metadanych.
datasourceDetails	query	boolean	Czy zwracać szczegóły źródła danych
getArtifactUsers	query	boolean	Czy zwrócić szczegóły użytkownika dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
lineage	query	boolean	Czy zwracać informacje o pochodzenia (nadrzędne przepływy danych, kafelki, identyfikatory źródeł danych)

Treść żądania

Nazwa	Typ	Opis
workspaces	string[]	Wymagane identyfikatory obszarów roboczych do skanowania (obsługują od 1 do 100 identyfikatorów obszarów roboczych)

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted	ScanRequest	Zaakceptowano

Przykłady

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"
}

Definicje

Nazwa	Opis
PowerBIApiErrorResponseDetail	Szczegółowe informacje o odpowiedzi na błędy usługi Power BI
RequiredWorkspaces	Żądanie wymaganych obszarów roboczych
ScanRequest	Żądanie skanowania

PowerBIApiErrorResponseDetail

Szczegółowe informacje o odpowiedzi na błędy usługi Power BI

Nazwa	Typ	Opis
code	string	Kod błędu
message	string	Komunikat o błędzie.
target	string	Cel błędu

RequiredWorkspaces

Żądanie wymaganych obszarów roboczych

Nazwa	Typ	Opis
workspaces	string[]	Wymagane identyfikatory obszarów roboczych do skanowania (obsługują od 1 do 100 identyfikatorów obszarów roboczych)

ScanRequest

Żądanie skanowania

Nazwa	Typ	Opis
createdDateTime	string	Data i godzina utworzenia skanowania
error	PowerBIApiErrorResponseDetail	Błąd skanowania (jeśli istnieje)
id	string	Identyfikator skanowania
status	string	Stan skanowania