Apps - Get Dashboard

Layanan:

Power BI REST APIs

Versi API:

v1.0

Mengembalikan dasbor yang ditentukan dari aplikasi yang ditentukan.

Cakupan yang Diperlukan

Dashboard.ReadWrite.All atau Dashboard.Read.All

Keterbatasan

Autentikasi perwakilan layanan tidak didukung.

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/dashboards/{dashboardId}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
appId	path	True	string (uuid)	ID aplikasi
dashboardId	path	True	string (uuid)	ID dasbor

Respons

Nama	Jenis	Deskripsi
200 OK	Dashboard	OK

Contoh

Example

Permintaan sampel

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

Respon sampel

Kode status:

200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "id": "03dac094-2ff8-47e8-b2b9-dedbbc4d22ac",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=335aee4b-7b38-48fd-9e2f-306c3fd67482&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ%3d%3d",
  "isReadOnly": false
}

Definisi

Nama	Deskripsi
Dashboard	Dasbor Power BI. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang dipanggil, izin pemanggil, dan ketersediaan data di database Power BI.
DashboardUser	Entri kanan akses pengguna Power BI untuk dasbor
DashboardUserAccessRight	Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)
PrincipalType	Jenis utama
ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.
Subscription	Langganan email untuk item Power BI (seperti laporan atau dasbor)
SubscriptionUser	Pengguna langganan email Power BI

Dashboard

Objek

Dasbor Power BI. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang dipanggil, izin pemanggil, dan ketersediaan data di database Power BI.

Nama	Jenis	Deskripsi
appId	string	ID aplikasi, dikembalikan hanya jika dasbor milik aplikasi
displayName	string	Nama tampilan dasbor
embedUrl	string	URL dasbor yang disematkan
id	string (uuid)	ID dasbor
isReadOnly	boolean	Apakah dasbor bersifat baca-saja
subscriptions	Subscription[]	(Nilai Kosong) Detail langganan untuk item Power BI (seperti laporan atau dasbor). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi langganan untuk laporan Power BI dengan menggunakan Dapatkan Langganan Laporan sebagai admin panggilan API.
users	DashboardUser[]	(Nilai kosong) Detail akses pengguna dasbor. Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda dapat mengambil informasi pengguna di dasbor Power BI dengan menggunakan panggilan Dapatkan Pengguna Dasbor sebagai Admin API, atau panggilan API PostWorkspaceInfo dengan parameter getArtifactUsers.
webUrl	string	URL web dasbor

DashboardUser

Objek

Entri kanan akses pengguna Power BI untuk dasbor

Nama	Jenis	Deskripsi
dashboardUserAccessRight	DashboardUserAccessRight	Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi utama
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.
userType	string	Jenis pengguna.

DashboardUserAccessRight

Enumeration

Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)

Nilai	Deskripsi
None	Tidak ada izin untuk konten di dasbor
Read	Memberikan akses Baca ke konten di dasbor
ReadWrite	Memberikan akses Baca dan Tulis ke konten di dasbor
ReadReshare	Memberikan akses Baca dan Reshare ke konten di dasbor
ReadCopy	Memberikan akses Baca dan Salin ke konten di dasbor
Owner	Memberikan akses Baca, Tulis, dan Buat Ulang ke konten dalam laporan

PrincipalType

Enumeration

Jenis utama

Nilai	Deskripsi
None	Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.
User	Jenis prinsipal pengguna
Group	Jenis prinsipal grup
App	Jenis perwakilan layanan

ServicePrincipalProfile

Objek

Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.

Nama	Jenis	Deskripsi
displayName	string	Nama profil perwakilan layanan
id	string (uuid)	ID profil perwakilan layanan

Subscription

Objek

Langganan email untuk item Power BI (seperti laporan atau dasbor)

Nama	Jenis	Deskripsi
artifactDisplayName	string	Nama item Power BI langganan (seperti laporan atau dasbor)
artifactId	string (uuid)	ID item Power BI langganan (seperti laporan atau dasbor)
artifactType	string	Jenis item Power BI (misalnya Report, Dashboard, atau Dataset)
attachmentFormat	string	Format laporan yang dilampirkan dalam langganan email
endDate	string (date-time)	Tanggal dan waktu akhir langganan email
frequency	string	Frekuensi langganan email
id	string (uuid)	ID langganan
isEnabled	boolean	Apakah langganan email diaktifkan
linkToContent	boolean	Apakah tautan langganan ada di langganan email
previewImage	boolean	Apakah cuplikan layar laporan ada di langganan email
startDate	string (date-time)	Tanggal dan waktu mulai langganan email
subArtifactDisplayName	string	Nama halaman item Power BI langganan, jika itu adalah laporan.
title	string	Nama aplikasi
users	SubscriptionUser[]	Detail setiap pelanggan email. Saat menggunakan panggilan Dapatkan Langganan Pengguna Sebagai Admin API, nilai yang dikembalikan adalah array kosong (null). Properti ini akan dihapus dari respons payload dalam rilis mendatang. Anda bisa mengambil informasi langganan pada laporan atau dasbor Power BI dengan menggunakan Dapatkan Langganan Laporan Sebagai Admin atau Dapatkan Langganan Dasbor Sebagai admin panggilan API.

SubscriptionUser

Objek

Pengguna langganan email Power BI

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan prinsipal
emailAddress	string	Alamat email pengguna
graphId	string	Pengidentifikasi prinsipal di Microsoft Graph. Hanya tersedia untuk API admin.
identifier	string	Pengidentifikasi utama
principalType	PrincipalType	Jenis utama
profile	ServicePrincipalProfile	Profil perwakilan layanan Power BI. Hanya relevan untuk solusi multi-penyewa Power BI Embedded.
userType	string	Jenis pengguna.