Admin - Reports GetReportsAsAdmin

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Retorna uma lista de relatórios para a organização.

Permissões

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

Ao executar em autenticação prinicipal de serviço, um aplicativo não deve ter quaisquer pré-remissões necessárias de consentimento do administrador para o Power BI definidas nele no portal do Azure.

Escopo necessário

Tenant.Read.All ou Tenant.ReadWrite.All

Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.

Limitações

Máximo de 50 solicitações por hora ou 5 solicitações por minuto, por locatário.

GET https://api.powerbi.com/v1.0/myorg/admin/reports

Com parâmetros opcionais:

GET https://api.powerbi.com/v1.0/myorg/admin/reports?$filter={$filter}&$top={$top}&$skip={$skip}

Parâmetros de URI

Nome	Em	Tipo	Description
$filter	query	string	Retorna um subconjunto de resultados com base em condição do parâmetro de consulta de filtro Odata.
$skip	query	integer (int32)	Ignora os primeiros n resultados
$top	query	integer (int32)	Retorna apenas os primeiros n resultados

Respostas

Nome	Tipo	Description
200 OK	AdminReports	OKEY

Exemplos

Example

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/admin/reports

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com//reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715",
      "workspaceId": "278e22a3-2aee-4057-886d-c3225423bc10"
    }
  ]
}

Definições

Nome	Description
AdminReport	Um relatório do Power BI retornado pelas APIs de Administrador. A API retorna um subconjunto da lista a seguir de propriedades de relatório. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
AdminReports	Wrapper de resposta OData para uma coleção de relatórios do Administrador do Power BI
PrincipalType	O tipo principal
ReportUser	Uma entrada certa 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 perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.
Subscription	Uma assinatura de email para um item do Power BI (como um relatório ou um painel)
SubscriptionUser	Um usuário de assinatura de email do Power BI

AdminReport

Objeto

Um relatório do Power BI retornado pelas APIs de Administrador. A API retorna um subconjunto da lista a seguir de propriedades de relatório. 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
createdBy	string	O proprietário do relatório. Disponível somente para relatórios criados após junho de 2019.
createdDateTime	string (date-time)	A data e a hora de criação do relatório
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
format	string	O tipo de formato de definição de relatório. Para PowerBIReport: PBIR PBIR-Legacy Para PaginatedReport: `RDL`
id	string (uuid)	A ID do relatório
isOwnedByMe	boolean	Indica se o usuário atual tem a capacidade de modificar ou criar uma cópia do relatório.
modifiedBy	string	O último usuário que modificou o relatório
modifiedDateTime	string (date-time)	A data e a hora em que o relatório foi modificado pela última vez
name	string	O nome do relatório. Os relatórios do aplicativo começam com o prefixo [App].
originalReportObjectId	string (uuid)	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 painel). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura para um relatório do Power BI usando o Obter Assinaturas de Relatório como Administrador chamada à 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 conteúdo em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando o Obter Usuários de Relatório como administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro `getArtifactUsers`.
webUrl	string	A URL da Web do relatório
workspaceId	string (uuid)	A ID do workspace (GUID) do relatório. Essa propriedade será retornada somente em GetReportsAsAdmin.

AdminReports

Objeto

Wrapper de resposta OData para uma coleção de relatórios do Administrador do Power BI

Nome	Tipo	Description
@odata.context	string	Contexto OData
value	AdminReport[]	A coleção de relatórios

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

ReportUser

Objeto

Uma entrada certa 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 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 solução de vários locatários do Power BI Embedded.
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

Enumeração

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

Valor	Description
None	Nenhuma permissão para conteúdo no relatório
Read	Concede acesso de leitura ao conteúdo no relatório
ReadWrite	Concede acesso de leitura e gravação ao conteúdo no relatório
ReadReshare	Concede acesso de leitura e compartilhamento ao conteúdo no relatório
ReadCopy	Concede acesso de leitura e cópia ao conteúdo no relatório
Owner	Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório

ServicePrincipalProfile

Objeto

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários 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`, `Dashboard`ou `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 o obter assinaturas de usuário como administrador chamada à API, 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 o Obter Assinaturas de Relatório como Administrador ou Obter Assinaturas do Painel como Administrador chamadas à API.

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 solução de vários locatários do Power BI Embedded.
userType	string	Tipo do usuário.

Compartilhar via

Admin - Reports GetReportsAsAdmin

Permissões

Escopo necessário

Limitações

Parâmetros de URI

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Definições

AdminReport

AdminReports

PrincipalType

ReportUser

ReportUserAccessRight

ServicePrincipalProfile

Subscription

SubscriptionUser