Dashboards - Get Dashboard In Group

Služba:

Power BI REST APIs

Verze rozhraní API:

v1.0

Vrátí zadaný řídicí panel ze zadaného pracovního prostoru.

Oprávnění

Toto volání rozhraní API je možné volat pomocí profilu instančního objektu. Další informace najdete v tématu Profily instančních objektů v Power BI Embedded.

Požadovaný obor

Dashboard.ReadWrite.All nebo Dashboard.Read.All

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
dashboardId	path	True	string uuid	ID řídicího panelu
groupId	path	True	string uuid	ID pracovního prostoru

Odpovědi

Name	Typ	Description
200 OK	Dashboard	OK

Příklady

Example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

200

{
  "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
}

Definice

Name	Description
Dashboard	Řídicí panel Power BI. Rozhraní API vrátí podmnožinu následujícího seznamu vlastností řídicího panelu. Podmnožina závisí na rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.
DashboardUser	Přístupová práva uživatele Power BI k řídicímu panelu
DashboardUserAccessRight	Přístupová práva, která má uživatel k řídicímu panelu (úroveň oprávnění)
PrincipalType	Typ objektu zabezpečení
ServicePrincipalProfile	Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
Subscription	E-mailový odběr položky Power BI (například sestavy nebo řídicího panelu)
SubscriptionUser	Uživatel e-mailového předplatného Power BI

Dashboard

Object

Řídicí panel Power BI. Rozhraní API vrátí podmnožinu následujícího seznamu vlastností řídicího panelu. Podmnožina závisí na rozhraní API, oprávněních volajícího a dostupnosti dat v databázi Power BI.

Name	Typ	Description
appId	string	ID aplikace, které se vrátí jenom v případě, že řídicí panel patří do aplikace
displayName	string	Zobrazovaný název řídicího panelu
embedUrl	string	Adresa URL řídicího panelu pro vložení
id	string	ID řídicího panelu
isReadOnly	boolean	Určuje, jestli je řídicí panel jen pro čtení
subscriptions	Subscription[]	(Prázdná hodnota) Podrobnosti o předplatném pro položku Power BI (například sestavu nebo řídicí panel). Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o předplatném pro sestavu Power BI můžete načíst pomocí volání Rozhraní API Získat odběry sestav jako Správa.
users	DashboardUser[]	(Prázdná hodnota) Podrobnosti o přístupu uživatele řídicího panelu Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o uživatelích na řídicím panelu Power BI můžete načíst pomocí volání Získat uživatele řídicího panelu jako Správa rozhraní API nebo volání rozhraní API PostWorkspaceInfo s parametrem getArtifactUsers .
webUrl	string	Webová adresa URL řídicího panelu

DashboardUser

Object

Přístupová práva uživatele Power BI k řídicímu panelu

Name	Typ	Description
dashboardUserAccessRight	DashboardUserAccessRight	Přístupová práva, která má uživatel k řídicímu panelu (úroveň oprávnění)
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 objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.

DashboardUserAccessRight

Enumeration

Přístupová práva, která má uživatel k řídicímu panelu (úroveň oprávnění)

Hodnota	Description
None	Žádná oprávnění k obsahu na řídicím panelu
Owner	Uděluje přístup ke čtení, zápisu a sdílení obsahu v sestavě.
Read	Uděluje oprávnění ke čtení obsahu na řídicím panelu.
ReadCopy	Uděluje přístup ke čtení a kopírování obsahu na řídicím panelu.
ReadReshare	Uděluje přístup ke čtení a sdílení obsahu na řídicím panelu.
ReadWrite	Udělí oprávnění ke čtení a zápisu k obsahu na řídicím panelu.

PrincipalType

Enumeration

Typ objektu zabezpečení

Hodnota	Description
App	Typ instančního objektu
Group	Typ objektu zabezpečení skupiny
None	Žádný typ objektu zabezpečení. Použijte pro přístup na úrovni celé organizace.
User	Typ objektu zabezpečení uživatele

ServicePrincipalProfile

Object

Profil objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.

Name	Typ	Description
displayName	string	Název profilu instančního objektu
id	string	ID profilu instančního objektu

Subscription

Object

E-mailový odběr položky Power BI (například sestavy nebo řídicího panelu)

Name	Typ	Description
artifactDisplayName	string	Název odebírané položky Power BI (například sestavy nebo řídicího panelu)
artifactId	string	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	Koncové datum a čas odběru e-mailu
frequency	string	Frekvence odběru e-mailů
id	string	ID předplatného
isEnabled	boolean	Jestli je povolený odběr e-mailu
linkToContent	boolean	Jestli v e-mailovém odběru existuje odkaz na odběr
previewImage	boolean	Jestli v e-mailovém odběru existuje snímek obrazovky se sestavou
startDate	string	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í volání rozhraní API Get User Subscriptions As Správa je vrácenou hodnotou prázdné pole (null). Tato vlastnost se odebere z odpovědi datové části v nadcházející verzi. Informace o předplatném sestavy nebo řídicího panelu Power BI můžete načíst pomocí volání rozhraní API Získat odběry sestav jako Správa nebo Získat odběry řídicího panelu jako Správa.

SubscriptionUser

Object

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 objektu zabezpečení služba Power BI. Relevantní pouze pro Power BI Embedded řešení s více tenanty.
userType	string	Typ uživatele.