Udostępnij za pośrednictwem


Dashboards - Get Dashboard In Group

Zwraca określony pulpit nawigacyjny z określonego obszaru roboczego.

Uprawnienia

To wywołanie interfejsu API może być wywoływane przez profil jednostki usługi. Aby uzyskać więcej informacji, zobacz: Profile jednostki usługi w Power BI Embedded.

Zakres wymagany

Dashboard.ReadWrite.All lub Dashboard.Read.All

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
dashboardId
path True

string

uuid

Identyfikator pulpitu nawigacyjnego

groupId
path True

string

uuid

Identyfikator obszaru roboczego

Odpowiedzi

Nazwa Typ Opis
200 OK

Dashboard

OK

Przykłady

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards/69ffaa6c-b36d-4d01-96f5-1ed67c64d4af

Sample Response

{
  "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "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. Podzbiór 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 główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

Subscription

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

SubscriptionUser

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

Dashboard

Pulpit nawigacyjny usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości pulpitu nawigacyjnego. Podzbiór 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

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 dla raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja.

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 Pobierz użytkowników pulpitu nawigacyjnego jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers .

webUrl

string

Internetowy adres URL pulpitu nawigacyjnego

DashboardUser

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 administratora.

identifier

string

Identyfikator podmiotu zabezpieczeń

principalType

PrincipalType

Typ podmiotu zabezpieczeń

profile

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

userType

string

Typ użytkownika.

DashboardUserAccessRight

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

Nazwa Typ Opis
None

string

Brak uprawnień do zawartości na pulpicie nawigacyjnym

Owner

string

Przyznaje uprawnienia do odczytu, zapisu i udostępniania dalej dostępu do zawartości w raporcie

Read

string

Przyznaje dostęp do odczytu do zawartości na pulpicie nawigacyjnym

ReadCopy

string

Przyznaje dostęp do odczytu i kopiowania do zawartości na pulpicie nawigacyjnym

ReadReshare

string

Przyznaje dostęp do odczytu i udostępniania dalej zawartości na pulpicie nawigacyjnym

ReadWrite

string

Przyznaje dostęp do odczytu i zapisu do zawartości na pulpicie nawigacyjnym

PrincipalType

Typ podmiotu zabezpieczeń

Nazwa Typ Opis
App

string

Typ jednostki usługi

Group

string

Typ podmiotu zabezpieczeń grupy

None

string

Brak typu podmiotu zabezpieczeń. Służy do uzyskiwania dostępu na poziomie całej organizacji.

User

string

Typ podmiotu zabezpieczeń użytkownika

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

Nazwa Typ Opis
displayName

string

Nazwa profilu jednostki usługi

id

string

Identyfikator profilu jednostki usługi

Subscription

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

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, Dashboardlub Dataset)

attachmentFormat

string

Format raportu dołączonego do subskrypcji poczty e-mail

endDate

string

Data i godzina zakończenia subskrypcji e-mail

frequency

string

Częstotliwość subskrypcji poczty e-mail

id

string

Identyfikator subskrypcji

isEnabled

boolean

Czy subskrypcja poczty e-mail jest włączona

linkToContent

boolean

Czy link subskrypcji istnieje w subskrypcji e-mail

previewImage

boolean

Czy na zrzucie ekranu raportu istnieje subskrypcja poczty e-mail

startDate

string

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 każdego subskrybenta poczty e-mail. W przypadku używania wywołania interfejsu API Pobierz subskrypcje użytkowników jako Administracja 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 opcji Pobierz subskrypcje raportów jako Administracja lub Pobierz subskrypcje pulpitu nawigacyjnego jako wywołania interfejsu API Administracja.

SubscriptionUser

Użytkownik subskrypcji 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 administratora.

identifier

string

Identyfikator podmiotu zabezpieczeń

principalType

PrincipalType

Typ podmiotu zabezpieczeń

profile

ServicePrincipalProfile

Profil główny usługa Power BI. Dotyczy tylko Power BI Embedded rozwiązania z wieloma dzierżawami.

userType

string

Typ użytkownika.