Reports - Get Reports In Group

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Retorna uma lista de relatórios do workspace especificado.

Como os relatórios paginados (RDL) não têm um conjunto de dados, o valor da ID do conjunto de dados na resposta da API para relatórios paginados não é exibido.

Permissões

Essa chamada à API pode ser chamada por um perfil de entidade de serviço. Para obter mais informações, consulte: Perfis de entidade de serviço no Power BI Embedded.

Escopo necessário

Report.ReadWrite.All ou Report.Read.All

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
groupId
 path True

string

uuid

A ID do workspace

Respostas

Nome Tipo Description
200 OK

Reports

OK

Exemplos

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"
    }
  ]
}

Definições

Nome Description
PrincipalType

O tipo de entidade de segurança
Report

Um relatório do Power BI. A API retorna um subconjunto da lista de propriedades de relatório a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
Reports

O wrapper de resposta OData para uma coleção de relatórios do Power BI
ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório
ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)
ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
Subscription

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

Um usuário de assinatura de email do Power BI

PrincipalType

O tipo de entidade de segurança

Nome Tipo Description
App

string

Tipo de entidade de serviço
Group

string

Tipo de entidade de grupo
None

string

Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.
User

string

Tipo de entidade de usuário

Report

Um relatório do Power BI. A API retorna um subconjunto da lista de propriedades de relatório a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

Nome Tipo Description
appId

string

A ID do aplicativo, retornada somente se o relatório pertencer a um aplicativo
datasetId

string

A ID do conjunto de dados do relatório
description

string

A descrição do relatório
embedUrl

string

A URL de inserção do relatório
id

string

A ID do relatório
isOwnedByMe

boolean

Determine se o relatório é criado pelo usuário atual.
name

string

O nome do relatório
originalReportId

string

A ID do relatório real quando o workspace é publicado como um aplicativo.
reportType enum:
  • PaginatedReport
  • PowerBIReport

O tipo de relatório
subscriptions

Subscription[]

(Valor vazio) Os detalhes da assinatura de um item do Power BI (como um relatório ou um dashboard). Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações de assinatura para um relatório do Power BI usando a chamada Obter Assinaturas de Relatório como Administração API.
users

ReportUser[]

(Valor vazio) Os detalhes de acesso do usuário para um relatório do Power BI. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando a chamada Obter Usuários de Relatório como Administração API ou a chamada à API PostWorkspaceInfo com o getArtifactUsers parâmetro .
webUrl

string

A URL da Web do relatório

Reports

O wrapper de resposta OData para uma coleção de relatórios do Power BI

Nome Tipo Description
odata.context

string

Contexto OData
value

Report[]

A coleção de relatórios

ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório

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 apenas para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo de entidade de segurança
profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
reportUserAccessRight

ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)
userType

string

Tipo do usuário.

ReportUserAccessRight

O direito de acesso que o usuário tem para o relatório (nível de permissão)

Nome Tipo Description
None

string

Nenhuma permissão para conteúdo no relatório
Owner

string

Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório
Read

string

Concede acesso de leitura ao conteúdo no relatório
ReadCopy

string

Concede acesso de leitura e cópia ao conteúdo no relatório
ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no relatório
ReadWrite

string

Concede acesso de leitura e gravação ao conteúdo no relatório

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço
id

string

A ID do perfil da entidade de serviço

Subscription

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

Nome Tipo Description
artifactDisplayName

string

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

string

A ID do item do Power BI assinado (como um relatório ou um dashboard)
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

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

string

A frequência da assinatura de email
id

string

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

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 obter assinaturas de usuário como Administração API, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações de assinatura em um relatório ou dashboard do Power BI usando as chamadas à API Obter Assinaturas de Relatório como Administração ou Obter Assinaturas de Painel como Administração.

SubscriptionUser

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 apenas para APIs de administrador.
identifier

string

Identificador da entidade de segurança
principalType

PrincipalType

O tipo de entidade de segurança
profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.
userType

string

Tipo do usuário.