Dashboards - Get Dashboard In Group

Mengembalikan dasbor yang ditentukan dari ruang kerja yang ditentukan.

Izin

Panggilan API ini dapat dipanggil oleh profil perwakilan layanan. Untuk informasi selengkapnya lihat: Profil perwakilan layanan di Power BI Embedded.

Cakupan yang Diperlukan

Dashboard.ReadWrite.All atau Dashboard.Read.All

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
dashboardId
path True

string

uuid

ID dasbor

groupId
path True

string

uuid

ID ruang kerja

Respons

Nama Jenis Deskripsi
200 OK

Dashboard

OK

Contoh

Example

Sample Request

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

Sample Response

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

Definisi

Nama Deskripsi
Dashboard

Dasbor Power BI. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang disebut, izin penelepon, dan ketersediaan data dalam 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 utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

Subscription

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

SubscriptionUser

Pengguna langganan email Power BI

Dashboard

Dasbor Power BI. API mengembalikan subset dari daftar properti dasbor berikut. Subset bergantung pada API yang disebut, izin penelepon, dan ketersediaan data dalam database Power BI.

Nama Jenis Deskripsi
appId

string

ID aplikasi, dikembalikan hanya jika dasbor milik aplikasi

displayName

string

Nama tampilan dasbor

embedUrl

string

URL semat dasbor

id

string

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 bisa mengambil informasi langganan untuk laporan Power BI dengan menggunakan Langganan Dapatkan Laporan sebagai panggilan API Admin.

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 Get Dashboard Users sebagai Admin panggilan API, atau panggilan POSTWorkspaceInfo API dengan getArtifactUsers parameter .

webUrl

string

URL web dasbor

DashboardUser

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 prinsipal

principalType

PrincipalType

Jenis utama

profile

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

userType

string

Jenis pengguna.

DashboardUserAccessRight

Hak akses yang dimiliki pengguna untuk dasbor (tingkat izin)

Nama Jenis Deskripsi
None

string

Tidak ada izin untuk konten di dasbor

Owner

string

Memberikan akses Baca, Tulis, dan Reshare ke konten dalam laporan

Read

string

Memberikan akses Baca ke konten di dasbor

ReadCopy

string

Memberikan akses Baca dan Salin ke konten di dasbor

ReadReshare

string

Memberikan akses Baca dan Reshare ke konten di dasbor

ReadWrite

string

Memberikan akses Baca dan Tulis ke konten di dasbor

PrincipalType

Jenis utama

Nama Jenis Deskripsi
App

string

Jenis perwakilan layanan

Group

string

Jenis utama grup

None

string

Tidak ada jenis utama. Gunakan untuk seluruh akses tingkat organisasi.

User

string

Jenis prinsipal pengguna

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

Nama Jenis Deskripsi
displayName

string

Nama profil perwakilan layanan

id

string

ID profil perwakilan layanan

Subscription

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

ID item Power BI langganan (seperti laporan atau dasbor)

artifactType

string

Jenis item Power BI (misalnya Report, , Dashboardatau Dataset)

attachmentFormat

string

Format laporan yang dilampirkan dalam langganan email

endDate

string

Tanggal dan waktu akhir langganan email

frequency

string

Frekuensi langganan email

id

string

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

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 Get User Subscriptions As 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 panggilan Dapatkan Langganan Laporan Sebagai Admin atau Dapatkan Langganan Dasbor Sebagai Admin API.

SubscriptionUser

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 prinsipal

principalType

PrincipalType

Jenis utama

profile

ServicePrincipalProfile

Profil utama layanan Power BI. Hanya relevan untuk solusi multipenyewa Power BI Embedded.

userType

string

Jenis pengguna.