Admin - Reports GetReportsAsAdmin

Service:

Power BI REST APIs

API Version:

v1.0

Zwraca listę raportów dla organizacji.

Uprawnienia

• Użytkownik musi mieć uprawnienia administratora (takie jak administrator globalny Office 365 lub administrator usługi Power BI) lub uwierzytelnić się przy użyciu jednostki usługi.
• Uprawnienia delegowane są obsługiwane.

W przypadku uruchamiania w ramach uwierzytelniania podstawowego usługi aplikacja nie może mieć żadnych premii wymaganych przez administratora dla usługi Power BI ustawionych w Azure Portal.

Zakres wymagany

Tenant.Read.All lub Tenant.ReadWrite.All

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

Ograniczenia

Maksymalnie 50 żądań na godzinę lub 5 żądań na minutę na dzierżawę.

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

With optional parameters:

GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
$filter	query		string	Filtruje wyniki na podstawie warunku logicznego
$skip	query		integer int32	Pomija pierwsze n wyników
$top	query		integer int32	Zwraca tylko pierwsze n wyników

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AdminReports	OK

Przykłady

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/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",
      "workspaceId": "278e22a3-2aee-4057-886d-c3225423bc10"
    }
  ]
}

Definicje

Nazwa	Opis
AdminReport	Raport usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzbiór następujących właściwości raportu. 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.
AdminReports	Otoka odpowiedzi OData dla kolekcji raportów usługi Power BI Administracja
PrincipalType	Typ podmiotu zabezpieczeń
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 e-mail usługi Power BI

AdminReport

Raport usługi Power BI zwrócony przez interfejsy API Administracja. Interfejs API zwraca podzbiór następujących właściwości raportu. 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 raport należy do aplikacji
createdBy	string	Właściciel raportu. Dostępne tylko dla raportów utworzonych po czerwcu 2019 r.
createdDateTime	string	Data i godzina utworzenia raportu
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.
modifiedBy	string	Ostatni użytkownik, który zmodyfikował raport
modifiedDateTime	string	Data i godzina ostatniej modyfikacji raportu
name	string	Nazwa raportu
originalReportId	string	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 dla raportu usługi Power BI można pobrać przy użyciu wywołania interfejsu API pobierania raportów jako Administracja.
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 pobierania raportów jako Administracja lub wywołania interfejsu API PostWorkspaceInfo z parametrem getArtifactUsers .
webUrl	string	Internetowy adres URL raportu
workspaceId	string	Identyfikator obszaru roboczego (GUID) raportu. Ta właściwość zostanie zwrócona tylko w getReportsAsAdmin.

AdminReports

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

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

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

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	Przyznaje prawa dostępu do odczytu, zapisu i udostępniania dalej do zawartości w raporcie
Read	string	Przyznaje dostęp do odczytu do zawartości w raporcie
ReadCopy	string	Przyznaje dostęp do odczytu i kopiowania do zawartości w raporcie
ReadReshare	string	Udziela dostępu do odczytu i udostępniania dalej zawartości w raporcie
ReadWrite	string	Przyznaje dostęp do odczytu i zapisu do 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 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.