Apps - Get Report

Služba:
Power BI REST APIs
Verze rozhraní API:
v1.0

Vrátí zadanou sestavu ze zadané aplikace.

Požadovaný obor

Report.ReadWrite.All nebo Report.Read.All

Omezení

Ověřování instančního objektu se nepodporuje. 

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
appId
 path True

string (uuid)

ID aplikace
reportId
 path True

string (uuid)

ID sestavy

Odpovědi

Name Typ Description
200 OK

Report

OK

Příklady

Example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
}

Definice

Name Description
PrincipalType

Typ objektu zabezpečení
Report

Sestava Power BI Rozhraní API vrátí podmnožinu následujících vlastností sestavy. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI.
ReportUser

Přístup uživatele Power BI ke správné položce pro sestavu
ReportUserAccessRight

Přístupové právo, které má uživatel pro sestavu (úroveň oprávnění)
ServicePrincipalProfile

Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
Subscription

Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)
SubscriptionUser

Uživatel e-mailového předplatného Power BI

PrincipalType

Výčet

Typ objektu zabezpečení

Hodnota Description
None

Žádný typ objektu zabezpečení. Používá se pro přístup na úrovni celé organizace.
User

Typ objektu zabezpečení uživatele
Group

Typ objektu zabezpečení skupiny
App

Typ instančního objektu

Report

Objekt

Sestava Power BI Rozhraní API vrátí podmnožinu následujících vlastností sestavy. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI.

Name Typ Description
appId

string

ID aplikace, vrácené pouze v případě, že sestava patří do aplikace
datasetId

string

ID datové sady sestavy
description

string

Popis sestavy
embedUrl

string

Adresa URL pro vložení sestavy
format

string

Typ formátu definice sestavy. Pro PowerBIReport:

Pro paginatedReport:
id

string (uuid)

ID sestavy
isOwnedByMe

boolean

Určuje, zda má aktuální uživatel možnost upravit nebo vytvořit kopii sestavy.
name

string

Název sestavy Sestavy aplikací začínají předponou [App].
originalReportId

string (uuid)

Skutečné ID sestavy při publikování pracovního prostoru jako aplikace.
reportType enum:
  • PaginatedReport
  • PowerBIReport

Typ sestavy
subscriptions

Subscription[]

(Prázdná hodnota) Podrobnosti předplatného pro položku Power BI (například sestavu nebo řídicí panel) Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném sestavy Power BI můžete načíst pomocí Získat odběry sestav jako volání rozhraní API pro správce.
users

ReportUser[]

(Prázdná hodnota) Podrobnosti o přístupu uživatele pro sestavu Power BI. Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o uživateli v sestavě Power BI můžete načíst pomocí volání rozhraní API Získat uživatele sestavy jako volání rozhraní API pro správu nebo volání rozhraní API PostWorkspaceInfo rozhraní API s parametrem getArtifactUsers.
webUrl

string

Webová adresa URL sestavy

ReportUser

Objekt

Přístup uživatele Power BI ke správné položce pro sestavu

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení
emailAddress

string

E-mailová adresa uživatele
graphId

string

Identifikátor objektu zabezpečení v Microsoft Graphu K dispozici pouze pro rozhraní API pro správu.
identifier

string

Identifikátor objektu zabezpečení
principalType

PrincipalType

Typ objektu zabezpečení
profile

ServicePrincipalProfile

Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
reportUserAccessRight

ReportUserAccessRight

Přístupové právo, které má uživatel pro sestavu (úroveň oprávnění)
userType

string

Typ uživatele

ReportUserAccessRight

Výčet

Přístupové právo, které má uživatel pro sestavu (úroveň oprávnění)

Hodnota Description
None

Žádná oprávnění k obsahu v sestavě
Read

Uděluje přístup pro čtení k obsahu v sestavě.
ReadWrite

Uděluje přístup pro čtení a zápis k obsahu v sestavě.
ReadReshare

Uděluje přístup ke čtení a opětovnému sdílení obsahu v sestavě.
ReadCopy

Uděluje přístup ke čtení a kopírování obsahu v sestavě.
Owner

Uděluje přístup ke čtení, zápisu a opětovnému sdílení obsahu v sestavě.

ServicePrincipalProfile

Objekt

Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.

Name Typ Description
displayName

string

Název instančního profilu
id

string (uuid)

ID profilu instančního objektu

Subscription

Objekt

Odběr e-mailu pro položku Power BI (například sestavu nebo řídicí panel)

Name Typ Description
artifactDisplayName

string

Název odebírané položky Power BI (například sestava nebo řídicí panel)
artifactId

string (uuid)

ID odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactType

string

Typ položky Power BI (například Report, Dashboardnebo Dataset)
attachmentFormat

string

Formát sestavy připojené k odběru e-mailu
endDate

string (date-time)

Koncové datum a čas odběru e-mailu
frequency

string

Frekvence odběru e-mailů
id

string (uuid)

ID předplatného
isEnabled

boolean

Jestli je povolené e-mailové předplatné
linkToContent

boolean

Jestli odkaz na odběr existuje v e-mailovém předplatném
previewImage

boolean

Jestli v odběru e-mailu existuje snímek obrazovky sestavy
startDate

string (date-time)

Počáteční datum a čas odběru e-mailu
subArtifactDisplayName

string

Název stránky odebírané položky Power BI, pokud se jedná o sestavu.
title

string

Název aplikace
users

SubscriptionUser[]

Podrobnosti o každém odběrateli e-mailu Při použití získání uživatelských předplatných jako správce volání rozhraní API je vrácená hodnota prázdné pole (null). Tato vlastnost bude odebrána z odpovědi datové části v nadcházející verzi. Informace o předplatném můžete načíst na sestavě nebo řídicím panelu Power BI pomocí Získat předplatná sestav jako správce nebo získat předplatná řídicích panelů jako volání rozhraní API pro správce.

SubscriptionUser

Objekt

Uživatel e-mailového předplatného Power BI

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení
emailAddress

string

E-mailová adresa uživatele
graphId

string

Identifikátor objektu zabezpečení v Microsoft Graphu K dispozici pouze pro rozhraní API pro správu.
identifier

string

Identifikátor objektu zabezpečení
principalType

PrincipalType

Typ objektu zabezpečení
profile

ServicePrincipalProfile

Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded.
userType

string

Typ uživatele