Reports - Get Reports In Group

Servicio:

Power BI REST APIs

Versión de la API:

v1.0

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

Dado que los informes paginados (RDL) no tienen un conjunto de datos, no se muestra el valor del identificador del conjunto de datos en la respuesta de API para los informes paginados.

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 de en Power BI Embedded.

Ámbito requerido

Report.ReadWrite.All o Report.Read.All

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

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	Reports	De acuerdo

Ejemplos

Example

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Definiciones

Nombre	Description
PrincipalType	El tipo de entidad de seguridad
Report	Un informe de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. 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.
Reports	Contenedor de respuesta de OData para una colección de informes de Power BI
ReportUser	Una entrada adecuada de acceso de usuario de Power BI para un informe
ReportUserAccessRight	Derecho de acceso que el usuario tiene para el informe (nivel de permiso)
ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
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

PrincipalType

Enumeración

El tipo de entidad de seguridad

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

Report

Object

Un informe de Power BI. La API devuelve un subconjunto de la siguiente lista de propiedades de informe. 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 la aplicación, devuelto solo si el informe pertenece a una aplicación
datasetId	string	Identificador del conjunto de datos del informe
description	string	Descripción del informe
embedUrl	string	Dirección URL de inserción del informe
id	string (uuid)	Identificador del informe
isOwnedByMe	boolean	Indica si el usuario actual tiene la capacidad de modificar o crear una copia del informe.
name	string	Nombre del informe. Los informes de la aplicación comienzan con el prefijo [App].
originalReportId	string (uuid)	Identificador de informe real cuando el área de trabajo se publica como una aplicación.
reportType	enum: PaginatedReport PowerBIReport	El tipo de informe
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 la información de suscripción de un informe de Power BI mediante el Obtener suscripciones de informe como llamada API de administrador.
users	ReportUser[]	(Valor vacío) Detalles de acceso de usuario para un informe de Power BI. Esta propiedad se quitará de la respuesta de carga en una próxima versión. Puede recuperar información de usuario en un informe de Power BI mediante la llamada API de Obtener informes como administrador API o la llamada API de PostWorkspaceInfo con el parámetro getArtifactUsers.
webUrl	string	Dirección URL web del informe

Reports

Object

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

Nombre	Tipo	Description
@odata.context	string	Contexto de OData
value	Report[]	Colección de informes

ReportUser

Object

Una entrada adecuada de acceso de usuario de Power BI para un informe

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 administración.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
reportUserAccessRight	ReportUserAccessRight	Derecho de acceso que el usuario tiene para el informe (nivel de permiso)
userType	string	Tipo del usuario.

ReportUserAccessRight

Enumeración

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

Valor	Description
None	Sin permiso para el contenido del informe
Owner	Concede acceso de lectura, escritura y recompartición al contenido del informe
Read	Concede acceso de lectura al contenido del informe
ReadCopy	Concede acceso de lectura y copia al contenido del informe
ReadReshare	Concede acceso de lectura y volver a compartir el contenido del informe
ReadWrite	Concede acceso de lectura y escritura al contenido del informe

ServicePrincipalProfile

Object

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

Nombre	Tipo	Description
displayName	string	El nombre del perfil de entidad de servicio
id	string (uuid)	Identificador del perfil de la entidad de servicio

Subscription

Object

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 (uuid)	Identificador del elemento de Power BI suscrito (por ejemplo, un informe o un panel)
artifactType	string	Tipo de elemento de Power BI (por ejemplo, un Report, Dashboardo Dataset)
attachmentFormat	string	Formato del informe adjunto en la suscripción de correo electrónico
endDate	string (date-time)	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 (uuid)	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 (date-time)	La 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. Cuando se usa la llamada API de Obtener suscripciones de usuario como administrador, 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 de Obtener suscripciones de informe como administrador o Obtener suscripciones de panel como administrador API.

SubscriptionUser

Object

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 administración.
identifier	string	Identificador de la entidad de seguridad
principalType	PrincipalType	El tipo de entidad de seguridad
profile	ServicePrincipalProfile	Un perfil de entidad de servicio de Power BI. Solo es relevante para solución multiinquilino de Power BI Embedded.
userType	string	Tipo del usuario.