Apps - Get Report

Usługa:

Power BI REST APIs

Wersja interfejsu API:

v1.0

Zwraca określony raport z określonej aplikacji.

Wymagany zakres

Report.ReadWrite.All lub Report.Read.All

Ograniczenia

Uwierzytelnianie jednostki usługi nie jest obsługiwane.

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/reports/{reportId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
appId	path	True	string (uuid)	Identyfikator aplikacji
reportId	path	True	string (uuid)	Identyfikator raportu

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Report	OK

Przykłady

Example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "66b2570c-d9d3-40b2-83d9-1095c6700041",
  "name": "SalesMarketing",
  "webUrl": "https://app.powerbi.com/reports/66b2570c-d9d3-40b2-83d9-1095c6700041",
  "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=66b2570c-d9d3-40b2-83d9-1095c6700041&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ"
}

Definicje

Nazwa	Opis
PrincipalType	Typ podmiotu zabezpieczeń
Report	Raport usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości raportu. Podzestaw zależy od interfejsu API o nazwie, uprawnieniach wywołującego i dostępności danych w bazie danych usługi Power BI.
ReportUser	Wpis prawa dostępu użytkownika usługi Power BI dla raportu
ReportUserAccessRight	Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
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

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń

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

Report

Objekt

Raport usługi Power BI. Interfejs API zwraca podzestaw następujących właściwości raportu. 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 raport należy do aplikacji
datasetId	string	Identyfikator zestawu danych raportu
description	string	Opis raportu
embedUrl	string	Adres URL osadzania raportu
id	string (uuid)	Identyfikator raportu
isOwnedByMe	boolean	Wskazuje, czy bieżący użytkownik ma możliwość modyfikowania lub tworzenia kopii raportu.
name	string	Nazwa raportu. Raporty aplikacji zaczynają się od prefiksu [App].
originalReportId	string (uuid)	Rzeczywisty identyfikator raportu po opublikowaniu obszaru roboczego jako aplikacja.
reportType	enum: PaginatedReport PowerBIReport	Typ raportu
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	ReportUser[]	(Pusta wartość) Szczegóły dostępu użytkownika dla raportu usługi Power BI. Ta właściwość zostanie usunięta z odpowiedzi ładunku w nadchodzącej wersji. Informacje o użytkowniku w raporcie usługi Power BI można pobrać przy użyciu wywołania interfejsu API administratora Pobierz użytkowników raportów lub wywołania interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers.
webUrl	string	Internetowy adres URL raportu

ReportUser

Objekt

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

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.
reportUserAccessRight	ReportUserAccessRight	Prawo dostępu, które użytkownik ma dla raportu (poziom uprawnień)
userType	string	Typ użytkownika.

ReportUserAccessRight

Wyliczanie

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

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

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, Dashboardlub 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.