Compartilhar via

Admin - Reports GetReportSubscriptionsAsAdmin

Serviço:
Power BI REST APIs
Versão da API:
v1.0

Retorna uma lista de assinaturas de relatório junto com os detalhes do assinante. Essa é uma chamada à API de visualização.

Permissions

  • O usuário deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.
  • Há suporte para permissões delegadas.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Limitações

Máximo de 200 solicitações por hora. 

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
reportId
 path True

string (uuid)

A ID do relatório

Respostas

Nome Tipo Description
200 OK

Subscriptions

OKEY

Exemplos

Example

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
        }
      ]
    }
  ]
}

Definições

Nome Description
PrincipalType

O tipo principal
ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded.
Subscription

Uma assinatura de email para um item do Power BI (como um relatório ou um painel)
Subscriptions

Wrapper de resposta OData para assinaturas do Power BI
SubscriptionUser

Um usuário de assinatura de email do Power BI

PrincipalType

Enumeração

O tipo principal

Valor Description
None

Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização.
User

Tipo de entidade de usuário
Group

Tipo de entidade de grupo
App

Tipo de entidade de serviço

ServicePrincipalProfile

Objeto

Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço
id

string (uuid)

A ID do perfil da entidade de serviço

Subscription

Objeto

Uma assinatura de email para um item do Power BI (como um relatório ou um painel)

Nome Tipo Description
artifactDisplayName

string

O nome do item do Power BI assinado (como um relatório ou um painel)
artifactId

string (uuid)

A ID do item do Power BI assinado (como um relatório ou um painel)
artifactType

string

O tipo de item do Power BI (por exemplo, um Report, Dashboardou Dataset)
attachmentFormat

string

Formato do relatório anexado na assinatura de email
endDate

string (date-time)

A data e a hora de término da assinatura de email
frequency

string

A frequência da assinatura de email
id

string (uuid)

A ID da assinatura
isEnabled

boolean

Se a assinatura de email está habilitada
linkToContent

boolean

Se existe um link de assinatura na assinatura de email
previewImage

boolean

Se existe uma captura de tela do relatório na assinatura de email
startDate

string (date-time)

A data e a hora de início da assinatura de email
subArtifactDisplayName

string

O nome da página do item do Power BI assinado, se for um relatório.
title

string

O nome do aplicativo
users

SubscriptionUser[]

Os detalhes de cada assinante de email. Ao usar a chamada à API Obter Assinaturas de Usuário como Administrador, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura em um relatório ou dashboard do Power BI usando as chamadas obter assinaturas de relatório como administrador ou obter assinaturas de painel como chamadas à API de administrador.

Subscriptions

Objeto

Wrapper de resposta OData para assinaturas do Power BI

Nome Tipo Description
@odata.context

string

value

Subscription[]

Assinatura de email do Power BI

SubscriptionUser

Objeto

Um usuário de assinatura de email do Power BI

Nome Tipo Description
displayName

string

Nome de exibição da entidade de segurança
emailAddress

string

Endereço de email do usuário
graphId

string

Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo principal
profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded.
userType

string

Tipo do usuário.