Apps - Get Dashboard

Servicio:

Power BI REST APIs

Versión de la API:

v1.0

Devuelve el panel especificado de la aplicación especificada.

Ámbito requerido

Dashboard.ReadWrite.All o Dashboard.Read.All

Limitaciones

No se admite la autenticación de la entidad de servicio.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
appId	path	True	string uuid	El identificador de la aplicación
dashboardId	path	True	string uuid	El identificador del panel

Respuestas

Nombre	Tipo	Description
200 OK	Dashboard	Aceptar

Ejemplos

Example

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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
}

Definiciones

Nombre	Description
Dashboard	Un panel de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del panel. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.
DashboardUser	Una entrada correcta de acceso de usuario de Power BI para un panel
DashboardUserAccessRight	Derecho de acceso que el usuario tiene para el panel (nivel de permiso)
PrincipalType	Tipo de entidad de seguridad
ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
Subscription	Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)
SubscriptionUser	Un usuario de suscripción de correo electrónico de Power BI

Dashboard

Un panel de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades del panel. El subconjunto depende de la API denominada, los permisos del autor de la llamada y la disponibilidad de los datos en la base de datos de Power BI.

Nombre	Tipo	Description
appId	string	El identificador de aplicación, devuelto solo si el panel pertenece a una aplicación
displayName	string	Nombre para mostrar del panel
embedUrl	string	Dirección URL de inserción del panel
id	string	El identificador del panel
isReadOnly	boolean	Si el panel es de solo lectura
subscriptions	Subscription[]	(Valor vacío) Los detalles de la suscripción de un elemento de Power BI (como un informe o un panel). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar la información de suscripción de un informe de Power BI mediante la llamada a la API Obtener suscripciones a informes como Administración.
users	DashboardUser[]	(Valor vacío) Detalles de acceso del usuario del panel. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un panel de Power BI mediante la llamada a la API Obtener usuarios del panel como Administración o la llamada API PostWorkspaceInfo con el getArtifactUsers parámetro .
webUrl	string	Dirección URL web del panel

DashboardUser

Una entrada correcta de acceso de usuario de Power BI para un panel

Nombre	Tipo	Description
dashboardUserAccessRight	DashboardUserAccessRight	Derecho de acceso que el usuario tiene para el panel (nivel de permiso)
displayName	string	Nombre para mostrar de la entidad de seguridad
emailAddress	string	Dirección de correo electrónico del usuario
graphId	string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	Tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.

DashboardUserAccessRight

Derecho de acceso que el usuario tiene para el panel (nivel de permiso)

Nombre	Tipo	Description
None	string	Sin permiso para el contenido en el panel
Owner	string	Concede acceso de lectura, escritura y recompartición al contenido del informe
Read	string	Concede acceso de lectura al contenido en el panel
ReadCopy	string	Concede acceso de lectura y copia al contenido en el panel
ReadReshare	string	Concede acceso de lectura y recompartición al contenido en el panel
ReadWrite	string	Concede acceso de lectura y escritura al contenido en el panel

PrincipalType

Tipo de entidad de seguridad

Nombre	Tipo	Description
App	string	Tipo de entidad de servicio
Group	string	Tipo de entidad de seguridad de grupo
None	string	No hay ningún tipo de entidad de seguridad. Use para el acceso de nivel de organización completo.
User	string	Tipo de entidad de seguridad de usuario

ServicePrincipalProfile

Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.

Nombre	Tipo	Description
displayName	string	El nombre del perfil de entidad de servicio
id	string	El identificador de perfil de la entidad de servicio

Subscription

Una suscripción de correo electrónico para un elemento de Power BI (por ejemplo, un informe o un panel)

Nombre	Tipo	Description
artifactDisplayName	string	Nombre del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactId	string	Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactType	string	Tipo de elemento de Power BI (por ejemplo, , ReportDashboardo Dataset).
attachmentFormat	string	Formato del informe adjunto a la suscripción de correo electrónico
endDate	string	Fecha y hora de finalización de la suscripción de correo electrónico
frequency	string	La frecuencia de la suscripción de correo electrónico
id	string	El identificador de suscripción
isEnabled	boolean	Si la suscripción de correo electrónico está habilitada
linkToContent	boolean	Si existe un vínculo de suscripción en la suscripción de correo electrónico
previewImage	boolean	Indica si existe una captura de pantalla del informe en la suscripción de correo electrónico
startDate	string	Fecha y hora de inicio de la suscripción de correo electrónico
subArtifactDisplayName	string	Nombre de página del elemento de Power BI suscrito, si es un informe.
title	string	El nombre de la aplicación
users	SubscriptionUser[]	Detalles de cada suscriptor de correo electrónico. Cuando se usa la llamada API Obtener suscripciones de usuario como Administración, el valor devuelto es una matriz vacía (null). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción en un informe o panel de Power BI mediante obtener suscripciones de informe como Administración u Obtener suscripciones de panel como llamadas API de Administración.

SubscriptionUser

Un usuario de suscripción de correo electrónico de Power BI

Nombre	Tipo	Description
displayName	string	Nombre para mostrar de la entidad de seguridad
emailAddress	string	Dirección de correo electrónico del usuario
graphId	string	Identificador de la entidad de seguridad en Microsoft Graph. Solo está disponible para las API de administrador.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	Tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil principal de servicio Power BI. Solo es relevante para Power BI Embedded solución multiinquilino.
userType	string	Tipo del usuario.