Admin - Dashboards GetDashboardsAsAdmin
Vrátí seznam řídicích panelů pro organizaci.
Dovolení
- Uživatel musí být správcem infrastruktury nebo se musí ověřit pomocí instančního objektu.
- Delegovaná oprávnění jsou podporována.
Při spuštění v rámci ověřování prinicipal služby nesmí aplikace nesmí mít na webu Azure Portal nastavené žádné žádosti o udělení souhlasu správce pro Power BI.
Požadovaný obor
Tenant.Read.All nebo Tenant.ReadWrite.All
Relevantní pouze při ověřování prostřednictvím standardního delegovaného přístupového tokenu správce. Při ověřování pomocí instančního objektu nesmí být k dispozici.
Omezení
Maximálně 50 požadavků za hodinu nebo 5 požadavků za minutu na tenanta.
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
Parametry identifikátoru URI
| Name | V | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
$expand
|
query |
string |
Přijme čárkami oddělený seznam datových typů, který se v odpovědi rozbalí. Podporuje |
|
|
$filter
|
query |
string |
Vrátí podmnožinu výsledků na základě Odata podmínky parametru dotazu filtru. |
|
|
$skip
|
query |
integer (int32) |
Přeskočí první n výsledků. |
|
|
$top
|
query |
integer (int32) |
Vrátí pouze první n výsledků. |
Odpovědi
| Name | Typ | Description |
|---|---|---|
| 200 OK |
OK |
Příklady
Example
Ukázkový požadavek
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
Ukázková odpověď
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false,
"workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
}
]
}
Definice
| Name | Description |
|---|---|
|
Admin |
Řídicí panel Power BI vrácený rozhraními API pro správu Rozhraní API vrátí podmnožinu následujících vlastností řídicího panelu. Podmnožina závisí na rozhraní API volaného, oprávnění volajícího a dostupnosti dat v databázi Power BI. |
|
Admin |
Obálka odpovědi OData pro kolekci řídicích panelů Power BI |
|
Admin |
Dlaždice Power BI vrácená rozhraními API pro správu |
|
Dashboard |
Položka práva pro přístup uživatele Power BI k řídicímu panelu |
|
Dashboard |
Přístupové právo, které má uživatel pro řídicí panel (úroveň oprávnění) |
|
Principal |
Typ objektu zabezpečení |
|
Service |
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) |
|
Subscription |
Uživatel e-mailového předplatného Power BI |
AdminDashboard
Řídicí panel Power BI vrácený rozhraními API pro správu Rozhraní API vrátí podmnožinu následujících vlastností řídicího panelu. 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 řídicí panel patří do aplikace |
| displayName |
string |
Zobrazovaný název řídicího panelu |
| embedUrl |
string |
Adresa URL pro vložení řídicího panelu |
| id |
string (uuid) |
ID řídicího panelu |
| isReadOnly |
boolean |
Jestli je řídicí panel jen pro čtení |
| subscriptions |
(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. |
|
| tiles |
Dlaždice, které patří na řídicí panel |
|
| users |
(Prázdná hodnota) Podrobnosti o přístupu uživatele řídicího panelu. Tato vlastnost bude odebrána 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í Získat uživatele řídicího panelu jako volání rozhraní API pro správu nebo volání rozhraní API PostWorkspaceInfo pomocí parametru |
|
| webUrl |
string |
Webová adresa URL řídicího panelu |
| workspaceId |
string (uuid) |
ID (GUID) pracovního prostoru řídicího panelu. Tato vlastnost bude vrácena pouze v GetDashboardsAsAdmin. |
AdminDashboards
Obálka odpovědi OData pro kolekci řídicích panelů Power BI
| Name | Typ | Description |
|---|---|---|
| @odata.context |
string |
Kontext OData |
| value |
Kolekce řídicích panelů |
AdminTile
Dlaždice Power BI vrácená rozhraními API pro správu
| Name | Typ | Description |
|---|---|---|
| colSpan |
integer |
Početsloupcůchch |
| datasetId |
string |
ID datové sady. K dispozici pouze pro dlaždice vytvořené ze sestavy nebo pomocí datové sady, jako jsou dlaždice Q&A. |
| embedData |
string |
Data vložení pro dlaždici |
| embedUrl |
string |
Adresa URL pro vložení dlaždice |
| id |
string (uuid) |
ID dlaždice |
| reportId |
string (uuid) |
ID sestavy. K dispozici pouze pro dlaždice vytvořené ze sestavy. |
| rowSpan |
integer |
Počet řádků mezi dlaždicemi |
| title |
string |
Zobrazovaný název dlaždice |
DashboardUser
Položka práva pro přístup uživatele Power BI k řídicímu panelu
| Name | Typ | Description |
|---|---|---|
| dashboardUserAccessRight |
Přístupové právo, které má uživatel pro řídicí panel (ú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 |
Typ objektu zabezpečení |
|
| profile |
Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded. |
|
| userType |
string |
Typ uživatele |
DashboardUserAccessRight
Přístupové právo, které má uživatel pro řídicí panel (úroveň oprávnění)
| Hodnota | Description |
|---|---|
| None |
Žádné oprávnění k obsahu na řídicím panelu |
| Read |
Uděluje přístup pro čtení k obsahu na řídicím panelu. |
| ReadWrite |
Uděluje přístup pro čtení a zápis k obsahu na řídicím panelu. |
| ReadReshare |
Uděluje přístup ke čtení a sdílení obsahu na řídicím panelu. |
| ReadCopy |
Uděluje přístup ke čtení a kopírování obsahu na řídicím panelu. |
| Owner |
Uděluje přístup ke čtení, zápisu a opětovnému sdílení obsahu v sestavě. |
PrincipalType
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 |
ServicePrincipalProfile
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
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 |
| 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 |
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
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 |
Typ objektu zabezpečení |
|
| profile |
Profil instančního objektu Power BI. Relevantní pouze pro víceklientské řešení Power BI Embedded. |
|
| userType |
string |
Typ uživatele |