Compartir a través de

Admin - Reports GetReportSubscriptionsAsAdmin

Servicio:
Power BI REST APIs
Versión de la API:
v1.0

Devuelve una lista de suscripciones de informe junto con los detalles del suscriptor. Se trata de una llamada API en versión preliminar.

Permissions

  • El usuario debe ser un administrador de Fabric o autenticarse mediante una entidad de servicio.
  • Se admiten permisos delegados.

Ámbito requerido

Tenant.Read.All o Tenant.ReadWrite.All

Limitaciones

Máximo de 200 solicitudes por hora. 

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Parámetros de identificador URI

Nombre En Requerido Tipo Description
reportId
 path True

string (uuid)

Identificador del informe

Respuestas

Nombre Tipo Description
200 OK

Subscriptions

OK

Ejemplos

Example

Solicitud de ejemplo

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportId}/subscriptions

Respuesta de muestra

status code:
200 
{
  "value": [
    {
      "id": "18b746fe-c6d5-4a00-9523-05dc91424274",
      "title": "TestReportSubscription-1",
      "artifactId": "7b71b90a-a333-4006-b12c-ef3d767fa4e9",
      "artifactDisplayName": "Customer Profitability Sample",
      "subArtifactDisplayName": "Team Scorecard",
      "artifactType": "Report",
      "isEnabled": true,
      "frequency": "Daily",
      "startDate": "10/13/2021 12:00:00 AM",
      "endDate": "10/13/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": true,
      "attachmentFormat": "PNG",
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ]
}

Definiciones

Nombre Description
PrincipalType

El tipo de entidad de seguridad
ServicePrincipalProfile

Un perfil de entidad de servicio de Power BI. Solo es relevante para la 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)
Subscriptions

Contenedor de respuesta de OData para suscripciones de Power BI
SubscriptionUser

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

PrincipalType

Enumeración

El tipo de entidad de seguridad

Valor Description
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
Group

Tipo de entidad de seguridad de grupo
App

Tipo de entidad de servicio

ServicePrincipalProfile

Object

Un perfil de entidad de servicio de Power BI. Solo es relevante para la 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, , ReportDashboardo 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 a la API Get User Subscriptions As Admin , 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 a la API Get Report Subscriptions As Admin (Obtener suscripciones de informe como administrador ) o Get Dashboard Subscriptions As Admin API (Obtener suscripciones de panel como administrador).

Subscriptions

Object

Contenedor de respuesta de OData para suscripciones de Power BI

Nombre Tipo Description
@odata.context

string

value

Subscription[]

Suscripción de correo electrónico de Power BI

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 la solución multiinquilino de Power BI Embedded.
userType

string

Tipo del usuario.