Items - List Dashboards

Serviço:

Dashboard

Versão da API:

v1

Retorna uma lista de painéis do espaço de trabalho especificado.
Esta API suporta paginação.

Permissões

O chamador deve ter uma função de espaço de trabalho de visualizador .

Escopos delegados necessários

Workspace.Read.All ou Workspace.ReadWrite.All

Identidades suportadas pelo Microsoft Entra

Esta API suporta as identidades do Microsoft listadas nesta secção.

Identidade	Suporte
Utilizador	Sim
da entidade de serviço e identidades gerenciadas	Não

Interfaz

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dashboards

Com parâmetros opcionais:

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/dashboards?continuationToken={continuationToken}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
workspaceId	path	True	string (uuid)	O ID do espaço de trabalho.
continuationToken	query		string	Um token para recuperar a próxima página de resultados.

Respostas

Name	Tipo	Description
200 OK	Dashboards	Pedido concluído com sucesso.
Other Status Codes	ErrorResponse	Códigos de erro comuns: InvalidItemType - Tipo de item inválido

Exemplos

List dashboards in workspace example

Pedido de amostra

HTTP

GET https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/dashboards

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "id": "3546052c-ae64-4526-b1a8-52af7761426f",
      "displayName": "Dashboard Name 1",
      "description": "A dashboard description.",
      "type": "Dashboard",
      "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229"
    }
  ]
}

Definições

Name	Description
Dashboard	Um objeto de painel.
Dashboards	Uma lista de painéis.
ErrorRelatedResource	O objeto de detalhes do recurso relacionado ao erro.
ErrorResponse	A resposta de erro.
ErrorResponseDetails	Os detalhes da resposta de erro.
ItemTag	Representa uma tag aplicada em um item.
ItemType	O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Dashboard

Object

Um objeto de painel.

Name	Tipo	Description
description	string	A descrição do item.
displayName	string	O nome de exibição do item.
folderId	string (uuid)	O ID da pasta.
id	string (uuid)	O ID do item.
tags	ItemTag[]	Lista de tags aplicadas.
type	ItemType	O tipo de item.
workspaceId	string (uuid)	O ID do espaço de trabalho.

Dashboards

Object

Uma lista de painéis.

Name	Tipo	Description
continuationToken	string	O token para o próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
continuationUri	string	O URI do próximo lote de conjunto de resultados. Se não houver mais registros, ele será removido da resposta.
value	Dashboard[]	Uma lista de painéis.

ErrorRelatedResource

Object

O objeto de detalhes do recurso relacionado ao erro.

Name	Tipo	Description
resourceId	string	A ID do recurso envolvida no erro.
resourceType	string	O tipo de recurso envolvido no erro.

ErrorResponse

Object

A resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
moreDetails	ErrorResponseDetails[]	Lista de detalhes de erro adicionais.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.
requestId	string	ID da solicitação associada ao erro.

ErrorResponseDetails

Object

Os detalhes da resposta de erro.

Name	Tipo	Description
errorCode	string	Um identificador específico que fornece informações sobre uma condição de erro, permitindo uma comunicação padronizada entre nosso serviço e seus usuários.
message	string	Uma representação legível por humanos do erro.
relatedResource	ErrorRelatedResource	Os detalhes do recurso relacionados ao erro.

ItemTag

Object

Representa uma tag aplicada em um item.

Name	Tipo	Description
displayName	string	O nome da tag.
id	string (uuid)	O ID da tag.

ItemType

Enumeração

O tipo do item. Tipos de itens adicionais podem ser adicionados ao longo do tempo.

Valor	Description
ApacheAirflowJob	Um ApacheAirflowJob.
CopyJob	Um trabalho de cópia.
Dashboard	Painel do PowerBI.
DataPipeline	Um pipeline de dados.
Dataflow	Um fluxo de dados.
Datamart	Datamart do PowerBI.
DigitalTwinBuilder	Um DigitalTwinBuilder.
DigitalTwinBuilderFlow	Um fluxo de construtor de gêmeos digitais.
Environment	Um ambiente.
Eventhouse	Uma casa de eventos.
Eventstream	Um fluxo de eventos.
GraphQLApi	Uma API para o item GraphQL.
KQLDashboard	Um painel KQL.
KQLDatabase	Um banco de dados KQL.
KQLQueryset	Um conjunto de consultas KQL.
Lakehouse	Uma casa no lago.
MLExperiment	Uma experiência de aprendizagem automática.
MLModel	Um modelo de aprendizagem automática.
MirroredAzureDatabricksCatalog	Um catálogo de databricks azure espelhado.
MirroredDatabase	Um banco de dados espelhado.
MirroredWarehouse	Um armazém espelhado.
MountedDataFactory	Um MountedDataFactory.
Notebook	Um caderno.
PaginatedReport	Relatório paginado do PowerBI.
Reflex	Um reflexo.
Report	Relatório do PowerBI.
SQLDatabase	Um SQLDatabase.
SQLEndpoint	Um ponto de extremidade SQL.
SemanticModel	Modelo semântico do PowerBI.
SparkJobDefinition	Uma definição de trabalho de faísca.
VariableLibrary	Uma VariableLibrary.
Warehouse	Um armazém.
WarehouseSnapshot	Um instantâneo do Warehouse.