Apps - Get Dashboard

Serviço:: Power BI REST APIs

Versão da API:: v1.0

Retorna o painel especificado do aplicativo especificado.

Escopo necessário

Dashboard.ReadWrite.All ou Dashboard.Read.All

Limitações

Não há suporte para autenticação de entidade de serviço.

GET https://api.powerbi.com/v1.0/myorg/apps/{appId}/dashboards/{dashboardId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
appId	path	True	string (uuid)	O ID da aplicação
dashboardId	path	True	string (uuid)	A ID do painel

Respostas

Nome	Tipo	Description
200 OK	Dashboard	OKEY

Exemplos

Example

Solicitação de exemplo

GET https://api.powerbi.com/v1.0/myorg/apps/3d9b93c6-7b6d-4801-a491-1738910904fd/dashboards/{dashboardId}

Resposta de exemplo

Código de status:: 200

{
  "appId": "3d9b93c6-7b6d-4801-a491-1738910904fd",
  "id": "03dac094-2ff8-47e8-b2b9-dedbbc4d22ac",
  "displayName": "SalesMarketing",
  "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=335aee4b-7b38-48fd-9e2f-306c3fd67482&appId=3d9b93c6-7b6d-4801-a491-1738910904fd&config=eyJjbHVzdGVyVXJsIjoiaHR0cHM6Ly9XQUJJLVNPVVRILUNFTlRSQUwtVVMtcmVkaXJlY3QuYW5hbHlzaXMud2luZG93cy5uZXQifQ%3d%3d",
  "isReadOnly": false
}

Definições

Nome	Description
Dashboard	Um painel do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do painel. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
DashboardUser	Uma entrada certa de acesso de usuário do Power BI para um dashboard
DashboardUserAccessRight	O direito de acesso que o usuário tem para o painel (nível de permissão)
PrincipalType	O tipo principal
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

Dashboard

Objeto

Um painel do Power BI. A API retorna um subconjunto da lista a seguir de propriedades do painel. 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 painel pertencer a um aplicativo
displayName	string	O nome de exibição do painel
embedUrl	string	A URL de inserção do painel
id	string (uuid)	A ID do painel
isReadOnly	boolean	Se o painel é somente leitura
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	DashboardUser[]	(Valor vazio) Os detalhes de acesso do usuário do painel. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um painel do Power BI usando o Obter Usuários do Painel como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro `getArtifactUsers`.
webUrl	string	A URL da Web do painel

DashboardUser

Objeto

Uma entrada certa de acesso de usuário do Power BI para um dashboard

Nome	Tipo	Description
dashboardUserAccessRight	DashboardUserAccessRight	O direito de acesso que o usuário tem para o painel (nível de permissão)
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.

DashboardUserAccessRight

Enumeração

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

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

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 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.

Partilhar via

Apps - Get Dashboard

Escopo necessário

Limitações

Parâmetros de URI

Respostas

Exemplos

Example

Solicitação de exemplo

Resposta de exemplo

Definições

Dashboard

DashboardUser

DashboardUserAccessRight

PrincipalType

ServicePrincipalProfile

Subscription

SubscriptionUser