Reports - Get Reports

Service:

Power BI REST APIs

API Version:

v1.0

Zwraca listę raportów z obszaru Mój obszar roboczy.

Ten interfejs API zwraca również udostępnione raporty i raporty z udostępnionych aplikacji. Dostęp do raportów znajdujących się w udostępnionych obszarach roboczych można uzyskać przy użyciu interfejsu API pobierania raportów w grupie.

Ponieważ raporty podzielone na strony (RDL) nie mają zestawu danych, wartość identyfikatora zestawu danych w odpowiedzi interfejsu API dla raportów podzielonych na strony nie jest wyświetlana.

Wymagany zakres

Report.ReadWrite.All lub Report.Read.All

GET https://api.powerbi.com/v1.0/myorg/reports

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Reports	OK

Przykłady

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/reports

Sample Response

Status code:

200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
    }
  ]
}

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.
Reports	Otoka odpowiedzi OData dla kolekcji raportów 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 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 poczty e-mail usługi Power BI

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

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.

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	Identyfikator raportu
isOwnedByMe	boolean	Ustal, czy raport jest tworzony przez bieżącego użytkownika.
name	string	Nazwa raportu
originalReportId	string	Rzeczywisty identyfikator raportu po opublikowaniu obszaru roboczego jako aplikacja.
reportType	enum: PaginatedReport PowerBIReport	Typ raportu
subscriptions	Subscription[]	(Wartość pusta) 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ć za pomocą wywołania interfejsu API pobierania raportów jako wywołania interfejsu API Administracja.
users	ReportUser[]	(Wartość pusta) 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 Pobierz użytkowników raportu jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers .
webUrl	string	Internetowy adres URL raportu

Reports

Otoka odpowiedzi OData dla kolekcji raportów usługi Power BI

Nazwa	Typ	Opis
odata.context	string	Kontekst OData
value	Report[]	Kolekcja raportów

ReportUser

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

ReportUserAccessRight

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

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

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 poczty 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 poczty e-mail
previewImage	boolean	Czy zrzut ekranu raportu istnieje w subskrypcji 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 korzystania z wywołania interfejsu API Get User Subscriptions As 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ć za pomocą polecenia Pobierz subskrypcje raportów jako Administracja lub Pobierz subskrypcje pulpitu nawigacyjnego Jako wywołania interfejsu API Administracja.

SubscriptionUser

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