Dashboards - Get Dashboards In Group

Service:

Power BI REST APIs

API Version:

v1.0

Devuelve una lista de paneles del área de trabajo especificada.

Permisos

Un perfil de entidad de servicio puede llamar a esta llamada API. Para obtener más información, consulte: Perfiles de entidad de servicio en Power BI Embedded.

Ámbito requerido

Dashboard.ReadWrite.All o Dashboard.Read.All

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
groupId	path	True	string uuid	Identificador del área de trabajo

Respuestas

Nombre	Tipo	Description
200 OK	Dashboards	Aceptar

Ejemplos

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/dashboards

Sample Response

Status code:

200

{
  "value": [
    {
      "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
    }
  ]
}

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 llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.
Dashboards	Contenedor de respuesta de OData para una colección de paneles de Power BI
DashboardUser	Una entrada correcta de acceso de usuario de Power BI para un panel
DashboardUserAccessRight	Derecho de acceso que tiene el usuario para el panel (nivel de permiso)
PrincipalType	El 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 llamada, los permisos del autor de la llamada y la disponibilidad de datos en la base de datos de Power BI.

Nombre	Tipo	Description
appId	string	El identificador de la 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	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 (por ejemplo, un informe o un panel). Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de suscripción para un informe de Power BI mediante la llamada a la API Obtener suscripciones de 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

Dashboards

Contenedor de respuesta de OData para una colección de paneles de Power BI

Nombre	Tipo	Description
odata.context	string	Contexto de OData
value	Dashboard[]	Colección de paneles

DashboardUser

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

Nombre	Tipo	Description
dashboardUserAccessRight	DashboardUserAccessRight	Derecho de acceso que tiene el usuario 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	El 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 tiene el usuario para el panel (nivel de permiso)

Nombre	Tipo	Description
None	string	No hay 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 volver a compartir contenido en el panel
ReadWrite	string	Concede acceso de lectura y escritura al contenido en el panel

PrincipalType

El 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. Se usa 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	Nombre del perfil de entidad de servicio
id	string	Identificador del perfil de 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, Dashboard, Reporto Dataset).
attachmentFormat	string	Formato del informe adjunto en 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	Frecuencia de la suscripción de correo electrónico
id	string	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	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[]	Los detalles de cada suscriptor de correo electrónico. Al usar la llamada API Get User Subscriptions As 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 las llamadas api obtener suscripciones de informe como Administración o Obtener suscripciones de panel como Administración llamadas API.

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	El 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.