Compartir a través de


Admin - Reports GetReportSubscriptionsAsAdmin

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

Permisos

  • El usuario debe tener derechos de administrador (como Office 365 administrador global o administrador del servicio Power BI) 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

Aceptar

Ejemplos

Example

Sample Request

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

Sample Response

{
  "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 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)

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

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.

Subscriptions

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

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.