Reports - Get Reports In Group

  • Referencia
Service:
Power BI REST APIs
API Version:
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 de identificador del conjunto de datos en la respuesta de la 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 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

Aceptar

Ejemplos

Example

Sample Request

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

Sample Response

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 llamada, los permisos del autor de la llamada y la disponibilidad de 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

Entrada correcta 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 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

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

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 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, que se devuelve solo si el informe pertenece a una aplicación
datasetId

string

El 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

Identificador del informe
name

string

Nombre del informe
originalReportId

string

Identificador de informe real cuando el área de trabajo se publica como una aplicación.
reportType enum:
  • PaginatedReport
  • PowerBIReport

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

ReportUser[]

(Valor vacío) Detalles de acceso del 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 a la API Obtener usuarios de informes como Administración o la llamada API de PostWorkspaceInfo con el getArtifactUsers parámetro .
webUrl

string

Dirección URL web del informe

Reports

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

Entrada correcta 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 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.
reportUserAccessRight

ReportUserAccessRight

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

string

Tipo del usuario.

ReportUserAccessRight

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

Nombre Tipo Description
None

string

No hay permiso para el contenido del informe
Owner

string

Concede acceso de lectura, escritura y recompartición al contenido del informe
Read

string

Concede acceso de lectura al contenido del informe
ReadCopy

string

Concede acceso de lectura y copia al contenido del informe
ReadReshare

string

Concede acceso de lectura y volver a compartir el contenido del informe
ReadWrite

string

Concede acceso de lectura y escritura al contenido del informe

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.