Apps - Get Dashboard

Usługa:: Power BI REST APIs

Wersja interfejsu API:: v1.0

Zwraca określony pulpit nawigacyjny z określonej aplikacji.

Wymagany zakres

Dashboard.ReadWrite.All lub Dashboard.Read.All

Ograniczenia

Uwierzytelnianie jednostki usługi nie jest obsługiwane.

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/dashboards/{dashboardId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appId	path	True	string (uuid)	Identyfikator aplikacji
dashboardId	path	True	string (uuid)	Identyfikator pulpitu nawigacyjnego

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Dashboard	OK

Przykłady

Example

Przykładowe żądanie

GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards/{dashboardId}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "id": "03dac094-2ff8-47e8-b2b9-dedbbc4d22ac",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=335aee4b-7b38-48fd-9e2f-306c3fd67482&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ%3d%3d",
  "isReadOnly": false
}

Definicje

Nazwa	Opis
Dashboard	Pulpit nawigacyjny usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości pulpitu nawigacyjnego. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
DashboardUser	Wpis prawa dostępu użytkownika usługi Power BI dla pulpitu nawigacyjnego
DashboardUserAccessRight	Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)
PrincipalType	Typ podmiotu zabezpieczeń
ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
Subscription	Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
SubscriptionUser	Użytkownik subskrypcji poczty e-mail usługi Power BI

Dashboard

Objekt

Pulpit nawigacyjny usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości pulpitu nawigacyjnego. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.

Nazwa	Typ	Opis
appId	string	Identyfikator aplikacji zwrócony tylko wtedy, gdy pulpit nawigacyjny należy do aplikacji
displayName	string	Nazwa wyświetlana pulpitu nawigacyjnego
embedUrl	string	Adres URL osadzania pulpitu nawigacyjnego
id	string (uuid)	Identyfikator pulpitu nawigacyjnego
isReadOnly	boolean	Czy pulpit nawigacyjny jest tylko do odczytu
subscriptions	Subscription[]	(Pusta wartość) Szczegóły subskrypcji elementu usługi Power BI (takie jak raport lub pulpit nawigacyjny). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji raportu usługi Power BI można pobrać przy użyciu Pobierz subskrypcje raportów jako wywołanie interfejsu API administratora.
users	DashboardUser[]	(Pusta wartość) Szczegóły dostępu użytkownika pulpitu nawigacyjnego. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku na pulpicie nawigacyjnym usługi Power BI można pobrać przy użyciu wywołania interfejsu API administratora Pobierz użytkowników pulpitu nawigacyjnego lub wywołania interfejsu API PostWorkspaceInfo z parametrem `getArtifactUsers`.
webUrl	string	Internetowy adres URL pulpitu nawigacyjnego

DashboardUser

Objekt

Wpis prawa dostępu użytkownika usługi Power BI dla pulpitu nawigacyjnego

Nazwa	Typ	Opis
dashboardUserAccessRight	DashboardUserAccessRight	Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress	string	Adres e-mail użytkownika
graphId	string	Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
userType	string	Typ użytkownika.

DashboardUserAccessRight

Wyliczanie

Prawo dostępu, które użytkownik ma dla pulpitu nawigacyjnego (poziom uprawnień)

Wartość	Opis
None	Brak uprawnień do zawartości na pulpicie nawigacyjnym
Read	Przyznaje dostęp do odczytu zawartości na pulpicie nawigacyjnym
ReadWrite	Udziela dostępu do odczytu i zapisu do zawartości na pulpicie nawigacyjnym
ReadReshare	Udziela dostępu do odczytu i udostępniania dalej zawartości na pulpicie nawigacyjnym
ReadCopy	Udziela dostępu do odczytu i kopiowania zawartości na pulpicie nawigacyjnym
Owner	Udziela dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń

Wartość	Opis
None	Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.
User	Typ podmiotu zabezpieczeń użytkownika
Group	Typ podmiotu zabezpieczeń grupy
App	Typ jednostki usługi

ServicePrincipalProfile

Objekt

Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.

Nazwa	Typ	Opis
displayName	string	Nazwa profilu jednostki usługi
id	string (uuid)	Identyfikator profilu jednostki usługi

Subscription

Objekt

Subskrypcja poczty e-mail dla elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)

Nazwa	Typ	Opis
artifactDisplayName	string	Nazwa subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactId	string (uuid)	Identyfikator subskrybowanego elementu usługi Power BI (na przykład raportu lub pulpitu nawigacyjnego)
artifactType	string	Typ elementu usługi Power BI (na przykład `Report`, `Dashboard`lub `Dataset`)
attachmentFormat	string	Format raportu dołączonego do subskrypcji poczty e-mail
endDate	string (date-time)	Data i godzina zakończenia subskrypcji poczty e-mail
frequency	string	Częstotliwość subskrypcji poczty e-mail
id	string (uuid)	Identyfikator subskrypcji
isEnabled	boolean	Czy subskrypcja poczty e-mail jest włączona
linkToContent	boolean	Czy link subskrypcji istnieje w subskrypcji poczty e-mail
previewImage	boolean	Czy zrzut ekranu raportu istnieje w subskrypcji poczty e-mail
startDate	string (date-time)	Data i godzina rozpoczęcia subskrypcji poczty e-mail
subArtifactDisplayName	string	Nazwa strony subskrybowanego elementu usługi Power BI, jeśli jest to raport.
title	string	Nazwa aplikacji
users	SubscriptionUser[]	Szczegóły poszczególnych subskrybentów poczty e-mail. W przypadku używania wywołania interfejsu API Pobierz subskrypcje użytkowników jako administrator zwracana wartość jest pustą tablicą (null). Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o subskrypcji w raporcie lub pulpicie nawigacyjnym usługi Power BI można pobrać przy użyciu Pobierz subskrypcje raportów jako administrator lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API administratora.

SubscriptionUser

Objekt

Użytkownik subskrypcji poczty e-mail usługi Power BI

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana podmiotu zabezpieczeń
emailAddress	string	Adres e-mail użytkownika
graphId	string	Identyfikator podmiotu zabezpieczeń w programie Microsoft Graph. Dostępne tylko dla interfejsów API administratorów.
identifier	string	Identyfikator podmiotu zabezpieczeń
principalType	PrincipalType	Typ podmiotu zabezpieczeń
profile	ServicePrincipalProfile	Profil jednostki usługi Power BI. Dotyczy tylko rozwiązania wielodostępu usługi Power BI Embedded.
userType	string	Typ użytkownika.

Udostępnij przez

Apps - Get Dashboard

Wymagany zakres

Ograniczenia

Parametry identyfikatora URI

Odpowiedzi

Przykłady

Example

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Dashboard

DashboardUser

DashboardUserAccessRight

PrincipalType

ServicePrincipalProfile

Subscription

SubscriptionUser