Apps - Get Dashboard

Referência

Service:: Power BI REST APIs

API Version:: 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 a autenticação da 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	A ID do aplicativo
dashboardId	path	True	string uuid	A ID do painel

Respostas

Nome	Tipo	Description
200 OK	Dashboard	OK

Exemplos

Example

Sample Request

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

Sample Response

Status code:: 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 de propriedades do painel 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.
DashboardUser	Uma entrada à direita de acesso do 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 de entidade de segurança
ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
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

Um painel do Power BI. A API retorna um subconjunto da lista de propriedades do painel 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 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	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 do conteúdo 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	DashboardUser[]	(Valor vazio) Os detalhes de acesso do usuário do painel. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em um painel do Power BI usando a chamada à API Obter Usuários do Painel como Administração ou a chamada à API PostWorkspaceInfo com o `getArtifactUsers` parâmetro .
webUrl	string	A URL da Web do painel

DashboardUser

Uma entrada à direita de acesso do 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 de entidade de segurança
profile	ServicePrincipalProfile	Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.
userType	string	Tipo do usuário.

DashboardUserAccessRight

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

Nome	Tipo	Description
None	string	Nenhuma permissão para conteúdo no painel
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 painel
ReadCopy	string	Concede acesso de leitura e cópia ao conteúdo no painel
ReadReshare	string	Concede acesso de leitura e compartilhamento ao conteúdo no painel
ReadWrite	string	Concede acesso de leitura e gravação ao conteúdo no painel

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

ServicePrincipalProfile

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

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 painel)

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

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 somente 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 multilocação.
userType	string	Tipo do usuário.

Compartilhar via