Admin - Dashboards GetDashboardsAsAdmin

Referência

Service:: Power BI REST APIs

API Version:: v1.0

Retorna uma lista de painéis para a organização.

Permissões

O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI) 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 nenhuma pré-permissão necessária de consentimento do administrador para o Power BI definida 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/dashboards

With optional parameters:

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

Parâmetros de URI

Nome	Em	Tipo	Description
$expand	query	string	Aceita uma lista separada por vírgulas de tipos de dados, que serão expandidos embutidos na resposta. Dá suporte a `tiles`.
$filter	query	string	Filtra os resultados, com base em uma condição booliana
$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	AdminDashboards	OK

Exemplos

Example

Sample Request

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

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "displayName": "SalesMarketing",
      "embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
      "isReadOnly": false,
      "workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
    }
  ]
}

Definições

Nome	Description
AdminDashboard	Uma dashboard do Power BI retornada por APIs Administração. A API retorna um subconjunto da lista de propriedades dashboard 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.
AdminDashboards	O wrapper de resposta OData para uma coleção de dashboard do Power BI
AdminTile	Um bloco do Power BI retornado por APIs Administração.
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 dashboard (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 dashboard)
SubscriptionUser	Um usuário de assinatura de email do Power BI

AdminDashboard

Uma dashboard do Power BI retornada por APIs Administração. A API retorna um subconjunto da lista de propriedades dashboard 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 dashboard pertencer a um aplicativo
displayName	string	O nome de exibição do dashboard
embedUrl	string	A URL de inserção do dashboard
id	string	A ID do dashboard
isReadOnly	boolean	Se o dashboard é somente leitura
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 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.
tiles	AdminTile[]	Os blocos que pertencem ao dashboard
users	DashboardUser[]	(Valor vazio) O dashboard detalhes de acesso do usuário. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em uma dashboard 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 dashboard
workspaceId	string	A ID do workspace (GUID) do dashboard. Essa propriedade será retornada somente em GetDashboardsAsAdmin.